diff --git a/.build_docs.sh b/.build_docs.sh new file mode 100755 index 000000000..9a5607325 --- /dev/null +++ b/.build_docs.sh @@ -0,0 +1,129 @@ +#!/usr/bin/env bash +# Build the README files for this role from meta/argument_specs.yml. +# +# antsibull-docs turns argument_specs.yml into RST, Sphinx renders that RST to +# HTML (the same way the official Ansible website builds its docs), and pandoc +# converts the HTML to Markdown. Requires antsibull-docs, sphinx and pandoc on +# PATH. +# +# The script creates these at the repo root: +# README.md - the role's main README. People read it directly as plain +# text in the repo, and Markdown viewers render it: GitHub, +# Ansible Galaxy and Red Hat Automation Hub (the last two +# display role docs only as Markdown). This is the canonical +# README; it supersedes the plain-text and RST renderings, +# which are intentionally not emitted. +# README.html - link to the full styled page in sphinx_html/ +# sphinx_html/ - the Sphinx HTML output (the page plus its _static assets) +# +# RST is still produced internally (antsibull emits it and Sphinx consumes it to +# build the HTML) but is not copied out as README.rst. +# +# Markdown is produced from the Sphinx HTML by the .html_to_md.py helper (which +# calls pandoc). antsibull has no Markdown output and Sphinx has no Markdown +# builder that understands antsibull's option tables, so we convert the finished +# HTML instead. The Parameters and Attributes tables become real Markdown pipe +# tables (Galaxy strips the CSS classes antsibull uses to indent nested options, +# so .html_to_md.py encodes the nesting as dot markers in the Parameter column). +# +# NOTE: the HTML output (README.html + sphinx_html/) is included here only +# to preview the styled page in the draft PR. The bundled fonts are trimmed to +# just the FontAwesome icon font (see below), so it is ~0.6MB rather than ~10MB; +# body text falls back to the system sans-serif. Long term, the +# full styled site is built once for the whole fedora.linux_system_roles +# collection, not per role, to keep each role repo small. README.html is a +# link, so commit the sphinx_html folder with it or the link will not resolve. +# +# antsibull-docs works with collections only. This repo has one role and +# is not a collection, so we first copy the role into a temporary +# fedora.linux_system_roles collection. Inside the real collection you do +# not need this step. +# +# Usage: ./.build_docs.sh + +set -euo pipefail + +for tool in antsibull-docs sphinx-build pandoc; do + command -v "$tool" >/dev/null 2>&1 || { echo "error: $tool not found on PATH" >&2; exit 1; } +done + +ROLE_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)" +ROLE_NAME="$(basename "$ROLE_DIR")" +OUT_DIR="$ROLE_DIR/sphinx_html" + +WORK="$(mktemp -d)" +trap 'rm -rf "$WORK"' EXIT + +# Copy this single role into a temporary collection. +COLL="$WORK/collections/ansible_collections/fedora/linux_system_roles" +mkdir -p "$COLL/roles" +ln -s "$ROLE_DIR" "$COLL/roles/$ROLE_NAME" +# version is mandatory but only used for the "part of the collection" note; +# leave it empty so antsibull omits the version from that note (this per-role +# build has no meaningful collection version). +cat > "$COLL/galaxy.yml" < "$COLL/README.md" +export ANSIBLE_COLLECTIONS_PATH="$WORK/collections" + +# antsibull makes the config files it needs: conf.py, antsibull-docs.cfg. +mkdir -p "$WORK/site" +antsibull-docs sphinx-init --use-current --squash-hierarchy \ + --dest-dir "$WORK/site" fedora.linux_system_roles + +cd "$WORK/site" + +# 1. antsibull turns argument_specs.yml into RST (same command as its build.sh). +# The RST is a build intermediate (Sphinx input below); it is not copied out. +chmod og-w rst # antsibull-docs wants this directory writable only by its owner +antsibull-docs --config-file antsibull-docs.cfg collection \ + --cleanup everything --use-current --squash-hierarchy \ + --dest-dir rst fedora.linux_system_roles + +# Ship only the rendered page, not its RST source. By default Sphinx copies +# the .rst files into _sources/ and adds a "Show Source" link; turn both off. +printf '\nhtml_copy_source = False\nhtml_show_sourcelink = False\n' >> conf.py + +# 2. Sphinx renders the RST to the styled HTML site (for the draft PR preview). +sphinx-build -M html rst build -q -c . + +# antsibull always renders a role by its collection FQCN (namespace.name.role). +# This role group is also published as classic Galaxy roles, so rewrite the +# role's FQCN "fedora.linux_system_roles." to the legacy role name +# "linux-system-roles." in the generated HTML, before it is copied out and +# converted to Markdown, so both the HTML preview and the derived README.md pick +# it up. Only the full role name is rewritten; bare "fedora.linux_system_roles" +# collection references (the "part of the collection" / "collection install" +# note) and the galaxy.ansible.com URL (which uses slashes) are left untouched. +find build/html -type f \( -name '*.html' -o -name 'searchindex.js' \) -print0 \ + | xargs -0 sed -i "s/fedora\.linux_system_roles\.${ROLE_NAME}/linux-system-roles.${ROLE_NAME}/g" + +rm -rf "$OUT_DIR" +mkdir -p "$OUT_DIR" +cp -r build/html/. "$OUT_DIR" # styled page plus its _static assets +rm -rf "$OUT_DIR/_sources" # empty leftover dir (RST source is not shipped) +# Trim the bundled fonts to just the FontAwesome icon font (woff2). The +# sphinx_rtd_theme ships Lato and Roboto Slab (body/heading text) plus +# FontAwesome (the UI icons: menu, home, previous/next) in four formats +# (ttf/woff/woff2/eot, ~9MB). The icon font is only ~75KB and has no system +# fallback, so keep it; the text fonts are ~1.8MB and fall back cleanly to the +# system sans-serif, so drop them. This cuts sphinx_html from ~10MB to ~0.6MB +# while keeping every UI icon. Scope the delete to the font directories so it +# cannot touch the SVG logos under _static/images. +for fontdir in "$OUT_DIR/_static/fonts" "$OUT_DIR/_static/css/fonts"; do + [ -d "$fontdir" ] && find "$fontdir" -type f ! -iname 'fontawesome-webfont.woff2' -delete +done +ln -sfn "sphinx_html/${ROLE_NAME}_role.html" "$ROLE_DIR/README.html" + +# 3. .html_to_md.py turns the HTML page into the main README.md (it calls pandoc +# for the prose and rebuilds the option tables as pipe tables). +python3 "$ROLE_DIR/.html_to_md.py" \ + "build/html/${ROLE_NAME}_role.html" "$ROLE_DIR/README.md" + +echo "MD : $ROLE_DIR/README.md" +echo "HTML: $ROLE_DIR/README.html -> sphinx_html/${ROLE_NAME}_role.html" diff --git a/.html_to_md.py b/.html_to_md.py new file mode 100755 index 000000000..646e847d0 --- /dev/null +++ b/.html_to_md.py @@ -0,0 +1,405 @@ +#!/usr/bin/env python3 +"""Convert the Sphinx-rendered role HTML page into README.md. + +README.md is the role's *main* README. It is what people read directly in the +repository as plain text, and what Markdown viewers render: GitHub, Ansible +Galaxy, and Red Hat Automation Hub (the last two display role documentation only +as Markdown). The content is authored once in meta/argument_specs.yml; +.build_docs.sh renders it to HTML (via antsibull-docs + Sphinx) and this script +turns that HTML into README.md. + +antsibull has no Markdown output and Sphinx has no Markdown builder that +understands antsibull's option tables, so we convert the finished HTML instead: + + - The prose sections (Synopsis, Notes, Examples, Authors) are a straight + pandoc HTML -> GitHub-Flavored-Markdown conversion. + - The Parameters and Attributes tables are rebuilt as real Markdown pipe + tables (not embedded HTML). Galaxy sanitizes the Markdown it renders + (markdown + nh3) and strips the CSS classes antsibull uses for indentation, + which would flatten nested options, so we encode the nesting ourselves: an + option's anchor path (parent/child/grandchild) gives its depth, shown with + one bullet marker per level in the Parameter column. Cell content is kept on + a single line (type, description, choices and default folded inline) because + a Markdown pipe-table cell cannot contain a line break without an HTML
. + The columns are padded with spaces (format_pipe_table) so the table reads + like a real table as plain text; the padding is stripped when rendered. + +Because this parses antsibull's rendered HTML (anchor id paths for depth, the +ansible-option-type-line for the type, the choices
  • list, the Default: +marker), the table parsing here needs updating if antsibull changes that HTML. +Where an expected marker is missing the script exits with a message naming it, +rather than failing with an opaque traceback. + +Usage: .html_to_md.py SPHINX_HTML_PAGE OUTPUT_README_MD +""" + +import html +import re +import subprocess +import sys + +# The bullet marker prepended once per nesting level in the Parameter column. +NEST_MARKER = "\N{BULLET} " + + +# --- pandoc helpers -------------------------------------------------------- + + +def run_pandoc(fragment): + """Convert an HTML fragment to GitHub-Flavored Markdown (raw, multi-line).""" + return subprocess.run( + ["pandoc", "-f", "html", "-t", "gfm", "--wrap=none"], + input=fragment, + capture_output=True, + text=True, + check=True, + ).stdout + + +def collapse(text): + """Squeeze all runs of whitespace (incl. newlines) into single spaces.""" + return " ".join(text.split()) + + +def pandoc_inline_many(fragments): + """Convert many HTML fragments in one pandoc call, one output line each. + + Pipe-table cells must be a single source line, so each result is collapsed + onto one line. The fragments are joined with a unique marker paragraph and + converted together (one subprocess instead of one per cell), then the output + is split back apart on that marker. Each fragment renders as its own + paragraph, so combining them does not change any individual result. + + Returns a list of Markdown strings, one per input fragment (same order). + """ + if not fragments: + return [] + marker = "@@CELLBREAK@@" + joined = f"\n\n

    {marker}

    \n\n".join(frag or "

    " for frag in fragments) + pieces = run_pandoc(joined).split(marker) + return [collapse(piece) for piece in pieces] + + +# --- small HTML utilities -------------------------------------------------- + + +def strip_tags(text): + return re.sub(r"<[^>]+>", "", text) + + +def unwrap_spans(text): + """Remove wrappers, keeping their text (innermost first). + + Sphinx nests spans (e.g. inline literals split one per + word, cross-references add std-ref spans); flattening them lets pandoc and + the table parser see clean text instead of per-word fragments. + """ + while True: + unwrapped = re.sub(r"]*>([^<]*)", r"\1", text) + if unwrapped == text: + return text + text = unwrapped + + +def esc_cell(text): + """Escape the pipe character so cell content cannot break the table.""" + return text.replace("|", "\\|") + + +def code_text(fragment): + """Return the unescaped text inside the first tag, else ''.""" + code = re.search(r"]*>(.*?)", fragment, re.S) + return html.unescape(strip_tags(code.group(1))).strip() if code else "" + + +# --- pipe-table rendering -------------------------------------------------- + + +def format_pipe_table(headers, rows): + """Render a Markdown pipe table with space-aligned columns. + + Cells are padded so the column borders line up in the raw Markdown, which + makes README.md read like a real table in a plain-text editor. The extra + spaces are valid GFM and are stripped when Galaxy/GitHub render the table, so + the rendered output is unchanged. The final column is left ragged: its cells + (descriptions) are long single lines, so padding them to the widest cell + would only add a wall of trailing spaces to every row. + + headers is the list of column names; rows is a list of already-escaped cell + lists, one per column. + """ + last = len(headers) - 1 + widths = [len(header) for header in headers] + for row in rows: + for index, cell in enumerate(row): + widths[index] = max(widths[index], len(cell)) + + def line(cells): + padded = [ + cell if index == last else cell.ljust(widths[index]) + for index, cell in enumerate(cells) + ] + return "| " + " | ".join(padded) + " |" + + separator = [ + "---" if index == last else "-" * widths[index] + for index in range(len(headers)) + ] + return "\n".join([line(headers), line(separator), *(line(row) for row in rows)]) + + +def cell_rows(table_html): + """Yield the list of inner-HTML strings for each non-header row.""" + for row in re.findall(r"]*>(.*?)", table_html, re.S): + if "]*>(.*?)", row, re.S) + + +def cell_inner(cell_td): + """Return the content inside the
    wrapper.""" + inner = re.search(r'
    (.*)
    ', cell_td, re.S) + return inner.group(1) if inner else cell_td + + +def require(match, what): + """Return match.group(1), or exit if the expected HTML marker is missing.""" + if not match: + sys.exit( + f"error: {what} not found in the role HTML; antsibull's markup " + "likely changed (see this script's module docstring)" + ) + return match.group(1) + + +def param_label(param_td): + """Build the Parameter-column label: bullet-nesting + **name** *type*.""" + path = require( + re.search(r'id="parameter-main--([^"]*)"', param_td), + 'an option anchor id ("parameter-main--...")', + ) + name = path.split("/")[-1] + type_line = re.search( + r'

    (.*?)

    ', param_td, re.S + ) + type_text = " ".join(strip_tags(type_line.group(1)).split()) if type_line else "" + label = f"**{name}**" + if type_text: + label += f" *{type_text}*" # type inline after the name, italic + return NEST_MARKER * path.count("/") + label # one marker per nesting level + + +def comment_description_html(cell): + """Return the HTML of the option's description (before any Choices/Default).""" + split_at = len(cell) + for marker in (r'

    ', r'

      '): + found = re.search(marker, cell) + if found: + split_at = min(split_at, found.start()) + return cell[:split_at].strip() + + +def comment_suffix(cell): + """Return the inline "Choices:"/"Default:" text for an option cell (no pandoc).""" + choices = re.search(r'
        (.*?)
      ', cell, re.S) + if choices: + values = [] + for item in re.findall(r"
    • (.*?)
      • ", choices.group(1), re.S): + value = code_text(item) + default = " (default)" if "ansible-option-default-bold" in item else "" + values.append(f"`{value}`{default}") + return "**Choices:** " + ", ".join(values) + # Options without choices may carry a standalone Default: line. + default = re.search(r"Default:.*?]*>(.*?)", cell, re.S) + if default: + value = html.unescape(strip_tags(default.group(1))).strip() + if value: + return f"**Default:** `{value}`" + return "" + + +def build_parameters(table_html): + """Rebuild the Parameters table as a space-aligned pipe table with nesting.""" + labels, cells = [], [] + for tds in cell_rows(table_html): + labels.append(param_label(tds[0])) + cells.append(cell_inner(tds[1])) + descriptions = pandoc_inline_many([comment_description_html(c) for c in cells]) + rows = [] + for label, cell, description in zip(labels, cells, descriptions): + comment = " ".join(part for part in (description, comment_suffix(cell)) if part) + rows.append([esc_cell(label), esc_cell(comment)]) + return format_pipe_table(["Parameter", "Comments"], rows) + + +def build_attributes(table_html): + """Rebuild the Attributes table (Attribute / Support / Description).""" + names, supports_html, descriptions_html = [], [], [] + for tds in cell_rows(table_html): + names.append(require( + re.search(r'id="attribute-([^"]*)"', tds[0]), + 'an attribute anchor id ("attribute-...")', + )) + # Drop the redundant "Support:" label (the column header already says it). + supports_html.append(re.sub( + r'.*?', + "", + cell_inner(tds[1]), + flags=re.S, + )) + descriptions_html.append(cell_inner(tds[2])) + supports = pandoc_inline_many(supports_html) + descriptions = pandoc_inline_many(descriptions_html) + rows = [ + [esc_cell(f"**{name}**"), esc_cell(support), esc_cell(description)] + for name, support, description in zip(names, supports, descriptions) + ] + return format_pipe_table(["Attribute", "Support", "Description"], rows) + + +# --- page body extraction and cleanup -------------------------------------- + + +def extract_body(doc): + """Return the
      block, tag-matching its nested
      s.""" + start = doc.find('
      in the HTML page') + depth = 0 + for match in re.finditer(r"<(/?)div\b", doc[start:]): + depth += -1 if match.group(1) else 1 + if depth == 0: + return doc[start : doc.find("
      ", start + match.start()) + 6] + sys.exit('error: unbalanced
      in the HTML page body') + + +def gh_slug(text): + """Return the heading anchor GitHub derives from a heading's text.""" + slug = text.strip().lower() + slug = re.sub(r"[^\w\- ]", "", slug) # drop the punctuation GitHub removes + return slug.replace(" ", "-") + + +def link_toc(body): + """Point the local contents TOC at GitHub-style in-file section anchors. + + Sphinx's own anchor ids differ from the ones GitHub derives from the + rendered headings, so recompute each TOC link target from its text. Dropping + the "reference internal" class also keeps these links (unlike the in-option + cross-references) from being flattened to plain text later. + """ + nav = re.search(r'', body, re.S) + if not nav: + return body + + def fix(match): + inner = match.group(1) + text = html.unescape(strip_tags(inner)).strip() + return f'{inner}' + + fixed = re.sub( + r']*>(.*?)', fix, nav.group(0), flags=re.S + ) + return body[: nav.start()] + fixed + body[nav.end() :] + + +def strip_sphinx_chrome(body): + """Remove Sphinx/antsibull HTML scaffolding that does not belong in Markdown.""" + # Flatten spans so both the table parser and pandoc see clean text. + body = unwrap_spans(body) + # Turn the contents TOC into working in-file section links, then flatten the + # remaining in-page cross-references (they point at anchors a flat README + # lacks) to plain text. + body = link_toc(body) + body = re.sub( + r']*class="reference internal"[^>]*>(.*?)', r"\1", body, flags=re.S + ) + # Drop the "Note" title Sphinx puts on admonition boxes; the box is gone in + # Markdown, so the bare label is just noise. + body = re.sub(r'

      .*?

      ', "", body, flags=re.S) + # Drop Sphinx heading permalink icons and unwrap the toc-backref anchors that + # wrap each heading; otherwise pandoc emits the heading as raw HTML and leaves + # its inline code as literal tags instead of Markdown backticks. + body = re.sub(r']*class="headerlink"[^>]*>.*?', "", body, flags=re.S) + body = re.sub( + r']*class="toc-backref"[^>]*>(.*?)', r"\1", body, flags=re.S + ) + # Drop the class from the remaining (external) links; pandoc cannot represent + # it in a Markdown link and would otherwise keep the whole anchor as raw HTML. + body = re.sub(r'(]*?)\s+class="[^"]*"', r"\1", body) + return body + + +def build_code_blocks(body): + """Swap Sphinx highlight blocks for placeholders; return (body, blocks). + + pandoc would render them as indented code blocks, so instead we emit fenced + ```yaml blocks (the Examples use YAML) and splice them back after pandoc. + """ + blocks = {} + + def replace(match): + pre = re.search(r"
      (.*?)
      ", match.group(0), re.S).group(1) + code = html.unescape(strip_tags(pre)).strip("\n") + key = f"@@CODE{len(blocks)}@@" + blocks[key] = f"```yaml\n{code}\n```" + return f"

      {key}

      " + + body = re.sub( + r'
      ]*>.*?\s*
      \s*
      ', + replace, + body, + flags=re.S, + ) + return body, blocks + + +def replace_option_tables(body, replacements): + """Swap each antsibull option table for a placeholder; build the pipe table. + + The built tables are stored in `replacements` (keyed by placeholder) and + spliced back after pandoc so pandoc never sees — and never mangles — an HTML + table. Parameters and Attributes tables are told apart by their anchor ids. + """ + tables = re.findall( + r"]*ansible-option-table[^>]*>.*?", body, re.S + ) + for index, table in enumerate(tables): + key = f"@@TABLE{index}@@" + if "parameter-main--" in table: + replacements[key] = build_parameters(table) + else: + replacements[key] = build_attributes(table) + body = body.replace(table, f"

      {key}

      ", 1) + return body + + +def main(): + if len(sys.argv) != 3: + sys.exit(f"usage: {sys.argv[0]} SPHINX_HTML_PAGE OUTPUT_README_MD") + html_path, md_path = sys.argv[1], sys.argv[2] + + with open(html_path, encoding="utf-8") as handle: + body = extract_body(handle.read()) + + body = strip_sphinx_chrome(body) + # Swap the code blocks and option tables for placeholders so pandoc never + # sees them; both are spliced back from `replacements` after conversion. + body, replacements = build_code_blocks(body) + body = replace_option_tables(body, replacements) + + md = run_pandoc(body) + + # Clean up Sphinx-isms pandoc passes through. + md = re.sub(r"]*>\n?", "", md) # section wrapper divs + md = re.sub(r"\n{3,}", "\n\n", md) + + for key, rendered in replacements.items(): + md = md.replace(key, rendered) + + with open(md_path, "w", encoding="utf-8") as handle: + handle.write(md.rstrip("\n") + "\n") # exactly one trailing newline + + +if __name__ == "__main__": + main() diff --git a/README.html b/README.html new file mode 120000 index 000000000..4ecb0a327 --- /dev/null +++ b/README.html @@ -0,0 +1 @@ +sphinx_html/network_role.html \ No newline at end of file diff --git a/README.md b/README.md index 502a8a5c2..3f5bf9bd5 100644 --- a/README.md +++ b/README.md @@ -1,1569 +1,550 @@ -# linux-system-roles/network -[![ansible-lint.yml](https://github.com/linux-system-roles/network/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/network/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/network/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/codeql.yml) [![codespell.yml](https://github.com/linux-system-roles/network/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/network/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/markdownlint.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/network/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/python-unit-test.yml) [![qemu-kvm-integration-tests.yml](https://github.com/linux-system-roles/network/actions/workflows/qemu-kvm-integration-tests.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/qemu-kvm-integration-tests.yml) [![shellcheck.yml](https://github.com/linux-system-roles/network/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/network/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/network/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/network/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/woke.yml) [![Coverage Status](https://coveralls.io/repos/github/linux-system-roles/network/badge.svg)](https://coveralls.io/github/linux-system-roles/network) [![Code Style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/linux-system-roles/network.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/linux-system-roles/network/context:python) -## Overview +# linux-system-roles.network role – Configure networking -The `network` role enables users to configure network on the target machines. -This role can be used to configure: +This role is part of the [fedora.linux_system_roles collection](https://galaxy.ansible.com/ui/repo/published/fedora/linux_system_roles/). -- Ethernet interfaces -- Bridge interfaces -- Bonded interfaces -- VLAN interfaces -- MacVLAN interfaces -- Infiniband interfaces -- Wireless (WiFi) interfaces -- IP configuration -- 802.1x authentication +It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. -## Introduction +To install it use: `ansible-galaxy collection install fedora.linux_system_roles`. -The `network` role supports two providers: `nm` and `initscripts`. `nm` is -used by default since RHEL7 and `initscripts` in RHEL6. The `initscripts` provider -requires `network-scripts` package which is deprecated in RHEL8 and dropped in -RHEL9. These providers can be 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. This means that `nm` requires at least NetworkManager's API version 1.2 -available and certain settings supported by `nm` provider also requires higher -NetworkManager's API version since which the settings are introduced. +To use it in a playbook, specify: `linux-system-roles.network`. -The `network` role supports two modules: `network_connections` and `network_state`. +- [Entry point `main` – Configure networking](#entry-point-main--configure-networking) -Since the backend of `network_state` is Nmstate, the `network_state` modules represents -the future direction for the network role, aiming to provide a more streamlined and -reliable way of managing network. As a result, the focus is on promoting the use of -`network_state` over the `network_connections` variable to ensure better consistency -and functionality moving forward. Additionally, most of the features currently -supported in NetworkManager are also available with `network_state`. For more -information and examples on how to configure the network using Nmstate schema in -`network_state` variable, please refer to the official documentation at -[nmstate.io](https://nmstate.io). For detailed syntax and explanations of each -parameter, visit -[nmstate's API documentation](https://docs.rs/nmstate/latest/nmstate/index.html). + - [Synopsis](#synopsis) -For each host a list of networking profiles can be configured via the -`network_connections` variable. + - [Parameters](#parameters) -- For `initscripts`, profiles correspond to ifcfg files in the - `/etc/sysconfig/network-scripts/` directory and those ifcfg files - has the line `NM_CONTROLLED=no` written. + - [Attributes](#attributes) -- For `nm`, profiles correspond to connection profiles are handled by - NetworkManager and only NetworkManager keyfile format profiles are - supported in `/etc/NetworkManager/system-connections/` since RHEL9. + - [Notes](#notes) -For each host the network state configuration can also be applied to the interface -directly via the `network_state` variable, and only the `nm` provider supports using -the `network_state` variable. + - [Examples](#examples) -Note that the `network` role both operates on the connection profiles of the devices -(via the `network_connections` variable) and on devices directly (via the -`network_state` variable). When configuring the connection profiles through the role, -it uses the profile name by default as the interface name. It is also possible to -create generic profiles, by creating for example a profile with a certain IP -configuration without activating the profile. To apply the configuration to the actual -networking interface, use the `nmcli` commands on the target system. + - [Authors](#authors) -**Warning**: The `network` role updates or creates all connection profiles on -the target system as specified in the `network_connections` variable. Therefore, -the `network` role removes options from the specified profiles if the options are -only present on the system but not in the `network_connections` variable. -Exceptions are mentioned below. However, the partial networking configuration can be -achieved via specifying the network state configuration in the `network_state` -variable. - -## Requirements - -See below - -### Collection requirements - -The role requires external collections only for management of `rpm-ostree` -nodes. Please run the following command to install them if you need to manage -`rpm-ostree` nodes: - -```bash -ansible-galaxy collection install -vv -r meta/collection-requirements.yml -``` - -## Variables - -The `network` role is configured via variables starting with `network_` as -the name prefix. List of variables: - -- `network_provider` - The `network_provider` variable allows to set a specific - provider (`nm` or `initscripts`) . Setting it to `{{ - network_provider_os_default }}`, the provider is set depending on the - operating system. This is usually `nm` except for RHEL 6 or CentOS 6 systems. - Changing the provider for an existing profile is not supported. To switch - providers, it is recommended to first remove profiles with the old provider - and then create new profiles with the new provider. -- `network_connections` - The connection profiles are configured as - `network_connections`, which is a list of dictionaries that include specific - options. -- `network_allow_restart` - It defaults to `false`. To load NetworkManager plugins - after installation, NetworkManager requires to be restarted. For example, if a - wireless connection is configured and NetworkManager-wifi is not installed, - NetworkManager must be restarted prior to the connection being configured. The - restart can result in connectivity loss and therefore the role does not allow it - without explicit consent. The user can consent to it by setting - `network_allow_restart` to `true`. Setting `network_allow_restart` to `false` will - prevent the role from restarting NetworkManager. -- `network_state` - The network state settings can be configured in the managed - 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 - -Setting the variables - -```yaml -network_provider: nm -network_connections: - - name: eth0 - #... -network_allow_restart: true -``` - -```yaml -network_provider: nm -network_state: - interfaces: - - name: eth0 - #... - routes: - config: - #... - dns-resolver: - config: - #... -``` - -## network_connections Options - -The `network_connections` variable is a list of dictionaries that include the -following options. List of options: - -### `name` (usually required) - -The `name` option identifies the connection profile to be configured. It is not -the name of the networking interface for which the profile applies, though we -can associate the profile with an interface and give them the same name. Note -that you can have multiple profiles for the same device, but only one profile -can be active on the device each time. For NetworkManager, a connection can -only be active at one device each time. - -- For `NetworkManager`, the `name` option corresponds to the - [`connection.id`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.connection.id) - property option. - Although NetworkManager supports multiple connections with the same `connection.id`, - the `network` role cannot handle a duplicate `name`. Specifying a `name` multiple - times refers to the same connection profile. - -- For `initscripts`, the `name` option determines the ifcfg file name `/etc/sysconfig/network-scripts/ifcfg-$NAME`. - Note that the `name` does not specify the `DEVICE` but a filename. As a consequence, - `'/'` is not a valid character for the `name`. - -You can also use the same connection profile multiple times. Therefore, it is possible -to create a profile and activate it separately. - -**Note:** The network role will only change the profiles that are specified in the -`network_connections` variable. Therefore, if only the ports of a profile are specified -to be removed from the controller and the controller is not specified, then the -controller profile will remain on the system. This can happen, if for example all ports -are removed from a bond interface. - -**Note:** To remove all profiles on a system that are not specified in the -`network_connections` variable, add an entry without a name and `persistent_state: -absent`. This will match and remove all remaining profiles: - -```yaml -network_connections: - - name: eth0 # profiles to keep/configure on the system - [...] - - - persistent_state: absent # remove all other profiles -``` - -### `state` - -The `state` option identifies what is the runtime state of each connection profile. The -`state` option (optional) can be set to the following values: - -- `up` - the connection profile is activated -- `down` - the connection profile is deactivated - -#### `state: up` - -- For `NetworkManager`, this corresponds to `nmcli connection id {{name}} up`. - -- For `initscripts`, this corresponds to `ifup {{name}}`. - -When the `state` option is set to `up`, you can also specify the `wait` option (optional): - -- `wait: 0` - initiates only the activation, but does not wait until the device is fully - connected. The connection will be completed in the background, for example after a - DHCP lease was received. -- `wait: ` is a timeout that enables you to decide how long you give the device - to activate. The default is using a suitable timeout. Note that the `wait` option is - only supported by NetworkManager. - -Note that `state: up` always re-activates the profile and possibly changes the -networking configuration, even if the profile was already active before. As -a consequence, `state: up` always changes the system. - -#### `state: down` - -- For `NetworkManager`, it corresponds to `nmcli connection id {{name}} down`. - -- For `initscripts`, it corresponds to call `ifdown {{name}}`. - -You can deactivate a connection profile, even if is currently not active. As a -consequence, `state: down` always changes the system. - -Note that if the `state` option is unset, the connection profile's runtime state will -not be changed. - -### `persistent_state` - -The `persistent_state` option identifies if a connection profile is persistent (saved on -disk). The `persistent_state` option can be set to the following values: - -#### `persistent_state: present` (default) - -Note that if `persistent_state` is `present` and the connection profile contains -the `type` option, the profile will be created or updated. If the connection profile is -incomplete (no `type` option), the behavior is undefined. Also, the `present` value -does not directly result in a change in the network configuration. If the `state` option -is not set to `up`, the profile is only created or modified, not activated. - -For NetworkManager, the new connection profile is created with the `autoconnect` -option enabled by default. Therefore, NetworkManager can activate the new -profile on a currently disconnected device. ([rh#1401515](https://bugzilla.redhat.com/show_bug.cgi?id=1401515)). - -#### `persistent_state: absent` - -The `absent` value ensures that the profile is not present on the -target host. If a profile with the given `name` exists, it will be deleted. In this case: - -- `NetworkManager` deletes all connection profiles with the corresponding - `connection.id`. Deleting a profile usually does not change the current networking - configuration, unless the profile was currently activated on a device. Deleting the - currently active connection profile disconnects the device. That makes the device - eligible to autoconnect another connection (for more details, see - [rh#1401515](https://bugzilla.redhat.com/show_bug.cgi?id=1401515)). - -- `initscripts` deletes the ifcfg file in most cases with no impact on the runtime state - of the system unless some component is watching the sysconfig directory. - -**Note**: For profiles that only contain a `state` option, the `network` role only activates -or deactivates the connection without changing its configuration. - -### `type` - -The `type` option can be set to the following values: - -- `ethernet` -- `bridge` -- `bond` -- `team` -- `vlan` -- `macvlan` -- `infiniband` -- `wireless` -- `dummy` - -#### `type: ethernet` - -If the type is `ethernet`, then there can be an extra `ethernet` dictionary with the following -items (options): `autoneg`, `speed` and `duplex`, which correspond to the -settings of the `ethtool` utility with the same name. - -- `autoneg`: `true` (default) or `false` [if auto-negotiation is enabled or disabled] -- `speed`: speed in Mbit/s -- `duplex`: `half` or `full` - -Note that the `speed` and `duplex` link settings are required when autonegotiation is -disabled (`autoneg: false`). - -#### `type: bridge`, `type: bond`, `type: team` - -The `bridge`, `bond`, `team` device types work similar. Note that `team` is not -supported in RHEL6 kernels, and has been deprecated in RHEL 9. - -For ports, the `port_type` and `controller` properties must be set. Note that ports -should not have `ip` settings, which means that the active ports will not have IP -addresses assigned. - -The `controller` refers to the `name` of a profile in the Ansible -playbook. It is neither an interface-name nor a connection-id of -NetworkManager. - -- For NetworkManager, `controller` will be converted to the `connection.uuid` - of the corresponding profile. - -- For initscripts, the controller is looked up as the `DEVICE` from the corresponding - ifcfg file. - -As `controller` refers to other profiles of the same or another play, the order of the -`connections` list matters. Profiles that are referenced by other profiles need to be -specified first. Also, `--check` ignores the value of the `controller` and assumes it -will be present during a real run. That means, in presence of an invalid `controller`, -`--check` may signal success but the actual play run fails. - -If only bringing down the `controller` profile , then the port profiles will be brought -down automatically. If bringing down the connection on some or all ports, then the -controller profile stay active. - -The `team` type uses `roundrobin` as the `runner` configuration. No further -configuration is supported at the moment. - -#### `type: vlan` - -Similar to `controller`, the `parent` references the connection profile in the ansible -role. The vlan ID can be specified by using nested vlan setting, the valid vlan ID -value ranges from 0 to 4094. Here is how to specify the vlan ID: - -```yaml -type: vlan -vlan: - id: 6 -``` - -#### `type: macvlan` - -Similar to `controller` and `vlan`, the `parent` references the connection profile in -the ansible role. - -#### `type: infiniband` - -For the infiniband connection, currently it is only supported for the nm provider, and -the following options are supported: - -- `p_key`: The infiniband P_Key to use for the device. When it is not specified, then - the connection is created on the physical infiniband fabrics. Otherwise, it is a - 16-bit unsigned integer and the ipoib (IP over Infiniband) connection will be - created, the high bit should be set if it is a "full membership" P_Key. The special - `p_key` values 0x0000 and 0x8000 are invalid as kernel does not support them. -- `transport_mode`: The ipoib (IP over Infiniband) connection operation mode. The - possible modes are `datagram` (default) and `connected`. - -**Note:** If the `p_key` is specified , then the `interface_name` must be unset. - -#### `type: wireless` - -The `wireless` type supports WPA-PSK (password) authentication, WPA-EAP (802.1x) -authentication, WPA3-Personal SAE (password) authentication and Enhanced Open (OWE). - -`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. - -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` - -- `password`: password for the network (required if `wpa-psk` or `sae` is used) - -#### `type: dummy` - -Dummy network interface, `nm` (NetworkManager) is the only supported `network_provider` -for this type. - -### `autoconnect` - -By default, profiles are created with autoconnect enabled. - -- For `NetworkManager`, this corresponds to the `connection.autoconnect` property. - -- For `initscripts`, this corresponds to the `ONBOOT` property. - -### `autoconnect_retries` - -The number of times a connection should be tried when autoactivating before giving up. -Zero means forever, -1 means the global default in NetworkManager (4 times if not -overridden). Setting this to 1 means to try activation only once before blocking -autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again. - -- For `NetworkManager`, this corresponds to the `connection.autoconnect-retries` property. - -### `mac` - -The `mac` address is optional and restricts the profile to be usable only on -devices with the given MAC address. `mac` is only allowed for `type` -`ethernet` or `infiniband` to match a non-virtual device with the -profile. The value of the `mac` address needs to be specified in hexadecimal notation -using colons (for example: `mac: "00:00:5e:00:53:5d"`). To avoid YAML parsing mac -addresses as integers in sexagesimal (base 60) notation (see -), it is recommended to always quote the value -with double quotes and sometimes it is necessary. - -- For `NetworkManager`, `mac` is the permanent MAC address, `ethernet.mac-address`. - -- For `initscripts`, `mac` is the currently configured MAC address of the device (`HWADDR`). - -### `cloned_mac` - -The `cloned_mac` address is optional and allow to specify the strategy to get the default -mac or to set your own mac. The value of the `cloned_mac` address needs to be specified in -hexadecimal notation like `mac` property. Besides explicitly specifying the value as a MAC -address with hexadecimal notation, the following special values are also supported: - -- `default`: honor the default behavior in NetworkManager -- `permanent`: use the permanent MAC address of the device -- `preserve`: don't change the MAC address of the device upon activation -- `random`: generate a randomized value upon each connect -- `stable`: generate a stable, hashed MAC address - -### `mtu` - -The `mtu` option denotes the maximum transmission unit for the profile's -device. The maximum value depends on the device. For virtual devices, the -maximum value of the `mtu` option depends on the underlying device. - -### `interface_name` - -For the `ethernet` and `infiniband` types, the `interface_name` option restricts the -profile to the given interface by name. This argument is optional and by default the -profile name is used unless a mac address is specified using the `mac` key. Specifying -an empty string (`""`) means that the profile is not restricted to a network interface. - -**Note:** With [persistent interface naming](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Networking_Guide/ch-Consistent_Network_Device_Naming.html), -the interface is predictable based on the hardware configuration. -Otherwise, the `mac` address might be an option. - -For virtual interface types such as bridges, the `interface_name` is the name of the created -interface. In case of a missing `interface_name`, the `name` of the profile name is used. - -**Note:** The `name` (the profile name) and the `interface_name` (the device name) may be -different or the profile may not be tied to an interface at all. - -### `match` - -Settings to specify devices or systems matching a profile. Currently, only the `path` -setting is implemented. - -The settings support a list of patterns which support the following modifiers and -wildcards: - -**Special modifiers for `match` settings:** - -- `|`, the element is an alternative, the match evaluates to be true if at least one of - the alternatives matches (logical OR). By default, an element is an alternative. - This means that an element `foo` behaves the same as `|foo` - -- `&`, the element is mandatory, the match evaluates to be true if all the element - matches (logical AND) - -- `!`, an element can also be inverted with exclamation mark (`!`) between the pipe - symbol (or the ampersand) and before the pattern. Note that `!foo` is a shortcut for - the mandatory match `&!foo` - -- `\`, a backslash can be used at the beginning of the element (after the optional - special characters) to escape the start of the pattern. For example, `&\!a` is an - mandatory match for literally `!a` - -**Wildcard patterns for `match` Settings:** -In general these work like shell globs. - -- `*`, matches zero or more of any character -- `?`, matches any single character -- `[fo]` - matches any single `f` or `o` character - also supports ranges - `[0-9]` - will match any single digit character - -### `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 -consists of a subsystem string (pci, usb, platform, etc.) and a subsystem-specific -identifier. The `ID_PATH` of a device can be obtained with the command -`udevadm info /sys/class/net/$dev | grep ID_PATH=` or by looking at the `path` property -exported by NetworkManager (`nmcli -f general.path device show $dev`). The `path` -setting is optional and restricts the profile to be activated only on devices with a -matching `ID_PATH`. The `path` setting is only supported for ethernet or infiniband -profiles. It supports modifiers and wildcards as described for match settings. - -### `zone` - -The `zone` option sets the firewalld zone for the interface. - -Ports to the bridge, bond or team devices cannot specify a zone. - -### `ip` - -The IP configuration supports the following options: - -- `address` - 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 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 - -- `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. - -- `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. - -- `dns` - - 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. - -- `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` - - **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. - -- `gateway4` and `gateway6` - - The default gateway for IPv4 (`gateway4`) or IPv6 (`gateway6`) packets. - -- `wait_ip` - - The property controls whether the system should wait for a specific IP stack to be - configured before considering the connection activated. It can be set to "any", - "ipv4","ipv6," or "ipv4+ipv6". When set to "any," the system considers the connection - activated when any IP stack is configured. "ipv4" ensures the system waits for IPv4 - configuration, while "ipv6" ensures the system waits for IPv6 configuration. The - "ipv4+ipv6" option requires both IPv4 and IPv6 to be configured before the connection - is considered activated. - -- `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 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. - -- `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: `gateway`, `metric`, `network`, `prefix`, `src`, `table` and - `type`. `network` and `prefix` specify the destination network. `src` specifies the - source IP address for a route. `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`. The network role does not create these routing table entries automatically. - You can use the `ansible.builtin.copy` module in your playbook to - define the named tables before applying the network role: - - ```yaml - - name: Ensure custom routing tables are defined - ansible.builtin.copy: - dest: /etc/iproute2/rt_tables.d/{{ item.name }}.conf - content: "{{ item.table_id }}\t{{ item.name }}\n" - loop: - - { table_id: 100, name: mytable1 } - - { table_id: 101, name: mytable2 } - become: true - ``` - - The optional `type` key supports the values - `blackhole`, `prohibit`, and `unreachable`. - See [man 8 ip-route](https://man7.org/linux/man-pages/man8/ip-route.8.html#DESCRIPTION) - for their definition. Routes with these types do not support a gateway. If the type - is not specified, the route is considered as a unicast route. Note that the classless - inter-domain routing(CIDR) notation or the network mask notation are not supported - for the `network` key. - -- `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 priority of the rule. A valid priority ranges from 0 to 4294967295. Higher - number means lower priority. - - `action` - - The action of the rule. The possible values are `to-table` (default), - `blackhole`, `prohibit`, `unreachable`. - - `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` - - The IP family of the rule. The possible values are `ipv4` and `ipv6`. - - `from` - - The source address of the packet to match (e.g. `192.168.100.58/24`). - - `fwmark` - - The fwmark value of the packet to match. - - `fwmask` - - The fwmask value of the packet to match. - - `iif` - - Select the incoming interface name to match. - - `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` - - Select the IP protocol value to match, the valid value ranges from 1 to 255. - - `oif` - - Select the outgoing interface name to match. - - `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` - - Reject routing decisions that have a prefix length of the specified or less. - - `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`. - The network role does not create these routing table entries automatically. - You can use the `ansible.builtin.copy` module in your playbook to - define the named tables before applying the network role: - - ```yaml - - name: Ensure custom routing tables are defined - ansible.builtin.copy: - dest: /etc/iproute2/rt_tables.d/{{ item.name }}.conf - content: "{{ item.table_id }}\t{{ item.name }}\n" - loop: - - { table_id: 100, name: mytable1 } - - { table_id: 101, name: mytable2 } - become: true - ``` - - - `to` - - The destination address of the packet to match (e.g. `192.168.100.58/24`). - - `tos` - - Select the tos value to match. - - `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. - - 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:** When `route_append_only` or `rule_append_only` is not specified, the network -role deletes the current routes or routing rules. - -**Note:** Ports to the bridge, bond or team devices cannot specify `ip` settings. - -### `ethtool` - -The ethtool settings allow to enable or disable various features. The names -correspond to the names used by the `ethtool` utility. Depending on the actual -kernel and device, changing some options might not be supported. - -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. - -```yaml - ethtool: - features: - esp_hw_offload: true|false # optional - esp_tx_csum_hw_offload: true|false # optional - fcoe_mtu: true|false # optional - gro: true|false # optional - gso: true|false # optional - highdma: true|false # optional - hw_tc_offload: true|false # optional - l2_fwd_offload: true|false # optional - loopback: true|false # optional - lro: true|false # optional - ntuple: true|false # optional - rx: true|false # optional - rx_all: true|false # optional - rx_fcs: true|false # optional - rx_gro_hw: true|false # optional - rx_udp_tunnel_port_offload: true|false # optional - rx_vlan_filter: true|false # optional - rx_vlan_stag_filter: true|false # optional - rx_vlan_stag_hw_parse: true|false # optional - rxhash: true|false # optional - rxvlan: true|false # optional - sg: true|false # optional - tls_hw_record: true|false # optional - tls_hw_tx_offload: true|false # optional - tso: true|false # optional - tx: true|false # optional - tx_checksum_fcoe_crc: true|false # optional - tx_checksum_ip_generic: true|false # optional - tx_checksum_ipv4: true|false # optional - tx_checksum_ipv6: true|false # optional - tx_checksum_sctp: true|false # optional - tx_esp_segmentation: true|false # optional - tx_fcoe_segmentation: true|false # optional - tx_gre_csum_segmentation: true|false # optional - tx_gre_segmentation: true|false # optional - tx_gso_partial: true|false # optional - tx_gso_robust: true|false # optional - tx_ipxip4_segmentation: true|false # optional - tx_ipxip6_segmentation: true|false # optional - tx_nocache_copy: true|false # optional - tx_scatter_gather: true|false # optional - tx_scatter_gather_fraglist: true|false # optional - tx_sctp_segmentation: true|false # optional - tx_tcp_ecn_segmentation: true|false # optional - tx_tcp_mangleid_segmentation: true|false # optional - tx_tcp_segmentation: true|false # optional - tx_tcp6_segmentation: true|false # optional - tx_udp_segmentation: true|false # optional - tx_udp_tnl_csum_segmentation: true|false # optional - tx_udp_tnl_segmentation: true|false # optional - tx_vlan_stag_hw_insert: true|false # optional - txvlan: true|false # optional - coalesce: - adaptive_rx: true|false # optional - adaptive_tx: true|false # optional - pkt_rate_high: 0 # optional minimum=0 maximum=0xffffffff - pkt_rate_low: 0 # optional minimum=0 maximum=0xffffffff - rx_frames: 0 # optional minimum=0 maximum=0xffffffff - rx_frames_high: 0 # optional minimum=0 maximum=0xffffffff - rx_frames_irq: 0 # optional minimum=0 maximum=0xffffffff - rx_frames_low: 0 # optional minimum=0 maximum=0xffffffff - rx_usecs: 0 # optional minimum=0 maximum=0xffffffff - rx_usecs_high: 0 # optional minimum=0 maximum=0xffffffff - rx_usecs_irq: 0 # optional minimum=0 maximum=0xffffffff - rx_usecs_low: 0 # optional minimum=0 maximum=0xffffffff - sample_interval: 0 # optional minimum=0 maximum=0xffffffff - stats_block_usecs: 0 # optional minimum=0 maximum=0xffffffff - tx_frames: 0 # optional minimum=0 maximum=0xffffffff - tx_frames_high: 0 # optional minimum=0 maximum=0xffffffff - tx_frames_irq: 0 # optional minimum=0 maximum=0xffffffff - tx_frames_low: 0 # optional minimum=0 maximum=0xffffffff - tx_usecs: 0 # optional minimum=0 maximum=0xffffffff - tx_usecs_high: 0 # optional minimum=0 maximum=0xffffffff - tx_usecs_irq: 0 # optional minimum=0 maximum=0xffffffff - tx_usecs_low: 0 # optional minimum=0 maximum=0xffffffff - ring: - rx: 0 # optional minimum=0 maximum=0xffffffff - rx_jumbo: 0 # optional minimum=0 maximum=0xffffffff - rx_mini: 0 # optional minimum=0 maximum=0xffffffff - tx: 0 # optional minimum=0 maximum=0xffffffff -``` - -### `ieee802_1x` - -Configures 802.1x authentication for an interface. - -Currently, NetworkManager is the only supported provider and EAP-TLS is the only -supported EAP method. - -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. - - Currently, `tls` is the default and the only accepted value. - -- `identity` (required) - - 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. - -- `private_key_password` - - 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. - - Multiple flags may be specified. - - Valid flags are: - - `none` - - `agent-owned` - - `not-saved` - - `not-required` - - 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. - -- `ca_cert` - - 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. - -- `system_ca_certs` - - 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. - -### `bond` - -The `bond` setting configures the options of bonded interfaces (type `bond`). -See the [kernel documentation for -bonding](https://www.kernel.org/doc/Documentation/networking/bonding.txt) or -your distribution `nmcli` documentation for valid values. It supports the -following options: - -- `mode` - - 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. - -- `ad_actor_system` - - 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`. - -- `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. - -- `all_ports_active` - - `all_slaves_active` 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`. - -- `arp_interval` - - 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`. - -- `arp_ip_target` - - 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. - -- `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`. - -- `lacp_rate` - - In `802.3ad` bonding mode, this option defines the rate in which we request 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. - -- `miimon` - - 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. - -- `num_grat_arp` - - This option specify the number of peer notifications (gratuitous 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. - -- `peer_notif_delay` - - 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. - -- `primary_reselect` - - 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. - -- `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. - -- `updelay` - - 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. - -- `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`. - -## Examples of Options - -Setting the same connection profile multiple times: - -```yaml -network_connections: - - name: Wired0 - type: ethernet - interface_name: eth0 - ip: - dhcp4: true - - - name: Wired0 - state: up -``` - -Activating a preexisting connection profile: - -```yaml -network_connections: - - name: eth0 - state: up -``` - -Deactivating a preexisting connection profile: - -```yaml -network_connections: - - name: eth0 - state: down -``` - -Creating a persistent connection profile: - -```yaml -network_connections: - - name: eth0 - #persistent_state: present # default - type: ethernet - autoconnect: true - mac: "00:00:5e:00:53:5d" - ip: - dhcp4: true -``` - -Specifying a connecting profile for an ethernet device with the `ID_PATH`: - -```yaml -network_connections: - - name: eth0 - type: ethernet - # For PCI devices, the path has the form "pci-$domain:$bus:$device.$function" - # The profile will only match the interface at the PCI address pci-0000:00:03.0 - match: - path: - - pci-0000:00:03.0 - ip: - address: - - 192.0.2.3/24 -``` +## Entry point `main` – Configure networking + +### Synopsis + +- The `network` role configures network interfaces and IP settings on the target machines. It can configure Ethernet, bridge, bonded, VLAN, MacVLAN, Infiniband, wireless (WiFi), and dummy interfaces, IP configuration, and 802.1x authentication. + +- The role supports two providers, `nm` (NetworkManager) and `initscripts`. `nm` is used by default since RHEL 7 and `initscripts` on RHEL 6. The `initscripts` provider requires the `network-scripts` package, which is deprecated in RHEL 8 and dropped in RHEL 9. The provider is autodetected per host from the distribution unless set explicitly with the `network_provider` variable. Neither provider is tied to a distribution: `nm` works wherever NetworkManager API version 1.2 or later is available, and some settings require a newer API version. + +- Two mechanisms are available to configure networking. The **`network_connections`** variable manages connection profiles (one list item per profile) and is supported by both providers. The **`network_state`** variable applies an Nmstate desired state directly to the devices and is only supported by the `nm` provider on RHEL 8 and later. + +- Because its backend is Nmstate, **`network_state`** represents the future direction of the role, aiming to provide a more streamlined and reliable way to manage networking; most features available in NetworkManager are also available through it. For the Nmstate schema, syntax, and examples, see [nmstate.io](https://nmstate.io) and the [nmstate API documentation](https://docs.rs/nmstate/latest/nmstate/index.html). + +- **Warning**: the `network` role updates or creates all connection profiles listed in **`network_connections`** on the target system, and it removes options that are present on the system but not in **`network_connections`**. Partial configuration can instead be achieved with **`network_state`**. + +- Collection requirements: to manage `rpm-ostree` nodes, the role requires additional modules from external collections; install them with `ansible-galaxy collection install -vv -r meta/collection-requirements.yml`. To manage other systems, the role has no additional requirements. + +- The role operates both on the connection profiles of devices (via **`network_connections`**) and on devices directly (via **`network_state`**). You can create generic profiles, for example a profile with a certain IP configuration, without activating them, then apply the configuration to the interface with `nmcli` on the target system. + +- Compatibility: both providers share the same configuration scheme, so the same playbook can be used with NetworkManager and initscripts. Not every option is handled identically by both providers, so do a test run with `--check` first. Creating a configuration with one provider and expecting another provider to handle it is not supported. The role also supports distributions that it treats like RHEL, such as AlmaLinux, CentOS, OracleLinux, and Rocky. + +- Invalid versus wrong configuration: the role rejects invalid configurations (test with `--check` first), but there is no protection against configuration that is valid but wrong. Double-check your configuration before applying it. + +- Limitations: the role does not bootstrap networking (consider [ansible-pull](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html) or auto-configuring the host during installation). For the `initscripts` provider, deploying a profile only writes the ifcfg files; nothing happens until an `up` or `down` state issues `ifup` or `ifdown`. The `initscripts` provider requires dependent profiles in the right order, for example a bonding controller before its ports. Removing a NetworkManager profile also takes the connection down and may remove virtual interfaces, while removing an `initscripts` profile does not change the current runtime state. For NetworkManager, modifying a connection with autoconnect enabled may activate a new profile, and deleting a connection that is currently active removes the interface, so order the steps and handle the `autoconnect` property carefully (see [rh#1401515](https://bugzilla.redhat.com/show_bug.cgi?id=1401515)). + +- Routing rules and named routing tables are not supported with the `initscripts` provider: if `network_provider` is set to `initscripts`, `routing_rule` entries and named `table` references in `route` are silently ignored. Use the `nm` provider for routing rule support. + +- Configuring `dns-resolver` through **`network_state`** is not supported when NetworkManager has a `[global-dns]` or `[global-dns-domain-*]` section in its configuration files (`/etc/NetworkManager/NetworkManager.conf` or a `conf.d` snippet). nmstate applies DNS through NetworkManager’s global DNS API, which NetworkManager rejects while global DNS is set in a configuration file; the role then fails with an error naming the file. Either remove the section and reload NetworkManager, or configure DNS on the connection profiles instead of `dns-resolver`. + +- The `network_connections` module is intended for internal use and integration testing only, and is not intended for direct external use. + +- For `rpm-ostree` systems, see the `README-ostree.md` file in the role. + +### Parameters + +| Parameter | Comments | +| ----------------------------------------------------------- | --- | +| **network_allow_restart** *boolean* | Whether the role is allowed to restart NetworkManager when a package installed for a wireless or team interface (such as `NetworkManager-wifi` or `NetworkManager-team`) requires it to be reloaded. A restart can disrupt connectivity, so the role refuses to restart NetworkManager unless this is set to `true`. **Choices:** `false` (default), `true` | +| **network_connections** *list / elements=dictionary* | A list of connection profile specifications to create, modify, activate, or remove. Profiles referenced by `controller` or `parent` must appear earlier in the list than the profile referencing them. To remove every profile on the system that is not otherwise listed, add an item with no `name` and `persistent_state` set to `absent`. **Default:** `[]` | +| • **autoconnect** *boolean* | Whether the profile is activated automatically. For `NetworkManager`, this corresponds to `connection.autoconnect`. For `initscripts`, this corresponds to `ONBOOT`. **Choices:** `false`, `true` (default) | +| • **autoconnect_retries** *integer* | The number of times to try autoactivating the connection before giving up. `0` means try forever, and `-1` uses the NetworkManager global default (normally 4 tries). `1` tries activation only once before blocking autoconnect until the next attempt to autoconnect. Only supported by the `nm` provider. **Default:** `-1` | +| • **bond** *dictionary* | The bonding options of a `bond` profile. See the [kernel bonding documentation](https://www.kernel.org/doc/Documentation/networking/bonding.txt) or your distribution’s `nmcli` documentation for valid values. | +| • • **ad_actor_sys_prio** *integer* | The 802.3ad system priority. Only valid with mode `802.3ad`. | +| • • **ad_actor_system** *string* | The 802.3ad system MAC address used for the actor in LACPDU protocol packet exchanges. Only valid with mode `802.3ad`. | +| • • **ad_select** *string* | The 802.3ad aggregation selection logic to use. Only valid with mode `802.3ad`. **Choices:** `"stable"`, `"bandwidth"`, `"count"` | +| • • **ad_user_port_key** *integer* | The upper 10 bits of the port key. Only valid with mode `802.3ad`. | +| • • **all_ports_active** *boolean* | Whether duplicate frames received on inactive ports are delivered (`true`) or dropped (`false`). **Choices:** `false`, `true` | +| • • **arp_all_targets** *string* | How many of `arp_ip_target` addresses must be reachable for the ARP monitor to consider a port up. Only valid with modes `balance-rr`, `active-backup`, `balance-xor`, or `broadcast`. **Choices:** `"any"`, `"all"` | +| • • **arp_interval** *integer* | The ARP link monitoring frequency in milliseconds. `0` disables ARP monitoring. Requires `arp_ip_target` to be set. Only valid with modes `balance-rr`, `active-backup`, `balance-xor`, or `broadcast`. | +| • • **arp_ip_target** *string* | The IP addresses to use as ARP monitoring peers when `arp_interval` is enabled. Requires `arp_interval` to be set. | +| • • **arp_validate** *string* | Whether ARP probes and replies should be validated in any mode that supports ARP monitoring, or whether non-ARP traffic should be filtered for link monitoring purposes. Only valid with modes `balance-rr`, `active-backup`, `balance-xor`, or `broadcast`. **Choices:** `"none"`, `"active"`, `"backup"`, `"all"`, `"filter"`, `"filter_active"`, `"filter_backup"` | +| • • **downdelay** *integer* | The time to wait, in milliseconds, before disabling a port after a link failure is detected. Requires `miimon` to be enabled. | +| • • **fail_over_mac** *string* | The policy for selecting the MAC address of the bond interface in `active-backup` mode. **Choices:** `"none"`, `"active"`, `"follow"` | +| • • **lacp_rate** *string* | The rate at which link partners are asked to transmit LACPDU packets. Only valid with mode `802.3ad`. **Choices:** `"slow"`, `"fast"` | +| • • **lp_interval** *integer* | The number of seconds between instances where the bonding driver sends learning packets to each port’s peer switch. | +| • • **miimon** *integer* | The MII link monitoring interval in milliseconds. | +| • • **min_links** *integer* | The minimum number of active links required before the carrier is asserted. | +| • • **mode** *string* | The bonding mode. **Choices:** `"balance-rr"` (default), `"active-backup"`, `"balance-xor"`, `"broadcast"`, `"802.3ad"`, `"balance-tlb"`, `"balance-alb"` | +| • • **num_grat_arp** *integer* | The number of gratuitous ARP peer notifications to issue after a failover event. | +| • • **packets_per_port** *integer* | The number of packets to transmit through a port before moving to the next one. Only valid with mode `balance-rr`. | +| • • **peer_notif_delay** *integer* | The delay, in milliseconds, between each peer notification issued after a failover event. Requires `miimon` to be enabled and must be a multiple of `miimon`. Not allowed together with `arp_interval`. | +| • • **primary** *string* | The name of the primary port device. Only valid with modes `active-backup`, `balance-tlb`, or `balance-alb`. | +| • • **primary_reselect** *string* | The reselection policy for the primary port. **Choices:** `"always"`, `"better"`, `"failure"` | +| • • **resend_igmp** *integer* | The number of IGMP membership reports to issue after a failover event. | +| • • **tlb_dynamic_lb** *boolean* | Whether dynamic shuffling of flows is enabled. Only valid with modes `balance-tlb` or `balance-alb`. **Choices:** `false`, `true` | +| • • **updelay** *integer* | The time to wait, in milliseconds, before enabling a port after a link recovery is detected. Requires `miimon` to be enabled. | +| • • **use_carrier** *boolean* | Whether the `netif_carrier_ok` function (`true`) or MII/ETHTOOL ioctls (`false`) are used to determine link status for `miimon`. **Choices:** `false`, `true` | +| • • **xmit_hash_policy** *string* | The transmit hash policy used for port selection. **Choices:** `"layer2"`, `"layer3+4"`, `"layer2+3"`, `"encap2+3"`, `"encap3+4"`, `"vlan+srcmac"` | +| • **check_iface_exists** *boolean* | Whether to check that the target interface exists before activating the connection. Only supported by the `nm` provider. **Choices:** `false`, `true` (default) | +| • **cloned_mac** *string* | The MAC address strategy to apply on activation. Accepts a hardware address in the same notation as `mac`, or one of the special values `default` (honor the NetworkManager default), `permanent` (use the device’s permanent address), `preserve` (do not change the current address), `random` (generate a new address on every connect), or `stable` (generate a stable, hashed address). **Default:** `"default"` | +| • **controller** *string* | The `name` of another profile in **`network_connections`** that this profile is a port of, used for `bridge`, `bond`, and `team` controller devices. This refers to a profile name in the play, not an interface name or NetworkManager connection ID. Ports must not specify `ip` or `zone` settings. | +| • **ethernet** *dictionary* | Ethernet link settings, corresponding to the `ethtool` utility’s link settings. Only allowed for `ethernet`, `vlan`, `bridge`, `bond`, and `team` types. | +| • • **autoneg** *boolean* | Whether auto-negotiation is enabled. When `speed` or `duplex` are set, `autoneg` must not be enabled, and when it is disabled, both `speed` and `duplex` must be set. **Choices:** `false`, `true` | +| • • **duplex** *string* | The link duplex mode. Required together with `speed` when `autoneg` is disabled. **Choices:** `"half"`, `"full"` | +| • • **speed** *integer* | The link speed in Mbit/s. Required together with `duplex` when `autoneg` is disabled. **Default:** `0` | +| • **ethtool** *dictionary* | Settings to enable or disable `ethtool` features on the device. Depending on the kernel and device, some settings might not be supported. | +| • • **coalesce** *dictionary* | A dictionary of `ethtool` interrupt coalescing settings. The `*_low` and `*_high` variants are only used when adaptive coalescing is enabled, applying while the measured packet rate is below `pkt_rate_low` or above `pkt_rate_high` respectively. | +| • • • **adaptive_rx** *boolean* | Whether adaptive Rx interrupt coalescing is enabled, letting the driver tune the Rx coalescing parameters dynamically based on the packet rate. **Choices:** `false`, `true` | +| • • • **adaptive_tx** *boolean* | Whether adaptive Tx interrupt coalescing is enabled, letting the driver tune the Tx coalescing parameters dynamically based on the packet rate. **Choices:** `false`, `true` | +| • • • **pkt_rate_high** *integer* | The packet rate, in packets per second, above which the `*_high` coalescing parameters are used. | +| • • • **pkt_rate_low** *integer* | The packet rate, in packets per second, below which the `*_low` coalescing parameters are used. | +| • • • **rx_frames** *integer* | The maximum number of received packets to wait for before raising an Rx interrupt. | +| • • • **rx_frames_high** *integer* | The number of received packets to wait for before raising an Rx interrupt while the packet rate is above `pkt_rate_high`. | +| • • • **rx_frames_irq** *integer* | The maximum number of received packets to wait for before raising an Rx interrupt while the host is already servicing an interrupt. | +| • • • **rx_frames_low** *integer* | The number of received packets to wait for before raising an Rx interrupt while the packet rate is below `pkt_rate_low`. | +| • • • **rx_usecs** *integer* | The number of microseconds to wait after a packet is received before raising an Rx interrupt. | +| • • • **rx_usecs_high** *integer* | The number of microseconds to wait before raising an Rx interrupt while the packet rate is above `pkt_rate_high`. | +| • • • **rx_usecs_irq** *integer* | The number of microseconds to wait before raising an Rx interrupt while the host is already servicing an interrupt. | +| • • • **rx_usecs_low** *integer* | The number of microseconds to wait before raising an Rx interrupt while the packet rate is below `pkt_rate_low`. | +| • • • **sample_interval** *integer* | How often, in seconds, the adaptive coalescing logic samples the packet rate. | +| • • • **stats_block_usecs** *integer* | The number of microseconds to wait between updates of the device’s in-memory statistics. | +| • • • **tx_frames** *integer* | The maximum number of packets to transmit before raising a Tx interrupt. | +| • • • **tx_frames_high** *integer* | The number of packets to transmit before raising a Tx interrupt while the packet rate is above `pkt_rate_high`. | +| • • • **tx_frames_irq** *integer* | The maximum number of packets to transmit before raising a Tx interrupt while the host is already servicing an interrupt. | +| • • • **tx_frames_low** *integer* | The number of packets to transmit before raising a Tx interrupt while the packet rate is below `pkt_rate_low`. | +| • • • **tx_usecs** *integer* | The number of microseconds to wait after a packet is transmitted before raising a Tx interrupt. | +| • • • **tx_usecs_high** *integer* | The number of microseconds to wait before raising a Tx interrupt while the packet rate is above `pkt_rate_high`. | +| • • • **tx_usecs_irq** *integer* | The number of microseconds to wait before raising a Tx interrupt while the host is already servicing an interrupt. | +| • • • **tx_usecs_low** *integer* | The number of microseconds to wait before raising a Tx interrupt while the packet rate is below `pkt_rate_low`. | +| • • **features** *dictionary* | A dictionary that enables (`true`) or disables (`false`) individual `ethtool` device features and offloads; every entry is a boolean toggle. Each key is a feature name: run `ethtool -k ` to list the features a device supports and see `man 8 ethtool` for the meaning of each one. The individual features are therefore not described separately below. Every feature also accepts a deprecated alias that uses dashes instead of underscores, matching the hyphen-separated feature names that `ethtool` and `nmcli` use natively (for example `tx-tcp-segmentation` for `tx_tcp_segmentation`); use the underscored name instead. | +| • • • **esp-hw-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **esp-tx-csum-hw-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **esp_hw_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **esp_tx_csum_hw_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **fcoe-mtu** *boolean* | **Choices:** `false`, `true` | +| • • • **fcoe_mtu** *boolean* | **Choices:** `false`, `true` | +| • • • **gro** *boolean* | **Choices:** `false`, `true` | +| • • • **gso** *boolean* | **Choices:** `false`, `true` | +| • • • **highdma** *boolean* | **Choices:** `false`, `true` | +| • • • **hw-tc-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **hw_tc_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **l2-fwd-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **l2_fwd_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **loopback** *boolean* | **Choices:** `false`, `true` | +| • • • **lro** *boolean* | **Choices:** `false`, `true` | +| • • • **ntuple** *boolean* | **Choices:** `false`, `true` | +| • • • **rx** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-all** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-fcs** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-gro-hw** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-udp_tunnel-port-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-vlan-filter** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-vlan-stag-filter** *boolean* | **Choices:** `false`, `true` | +| • • • **rx-vlan-stag-hw-parse** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_all** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_fcs** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_gro_hw** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_udp_tunnel_port_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_vlan_filter** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_vlan_stag_filter** *boolean* | **Choices:** `false`, `true` | +| • • • **rx_vlan_stag_hw_parse** *boolean* | **Choices:** `false`, `true` | +| • • • **rxhash** *boolean* | **Choices:** `false`, `true` | +| • • • **rxvlan** *boolean* | **Choices:** `false`, `true` | +| • • • **sg** *boolean* | **Choices:** `false`, `true` | +| • • • **tls-hw-record** *boolean* | **Choices:** `false`, `true` | +| • • • **tls-hw-tx-offload** *boolean* | **Choices:** `false`, `true` | +| • • • **tls_hw_record** *boolean* | **Choices:** `false`, `true` | +| • • • **tls_hw_tx_offload** *boolean* | **Choices:** `false`, `true` | +| • • • **tso** *boolean* | **Choices:** `false`, `true` | +| • • • **tx** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-checksum-fcoe-crc** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-checksum-ip-generic** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-checksum-ipv4** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-checksum-ipv6** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-checksum-sctp** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-esp-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-fcoe-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-gre-csum-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-gre-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-gso-partial** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-gso-robust** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-ipxip4-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-ipxip6-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-nocache-copy** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-scatter-gather** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-scatter-gather-fraglist** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-sctp-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-tcp-ecn-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-tcp-mangleid-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-tcp-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-tcp6-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-udp-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-udp_tnl-csum-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-udp_tnl-segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx-vlan-stag-hw-insert** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_checksum_fcoe_crc** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_checksum_ip_generic** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_checksum_ipv4** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_checksum_ipv6** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_checksum_sctp** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_esp_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_fcoe_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_gre_csum_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_gre_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_gso_partial** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_gso_robust** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_ipxip4_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_ipxip6_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_nocache_copy** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_scatter_gather** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_scatter_gather_fraglist** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_sctp_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_tcp6_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_tcp_ecn_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_tcp_mangleid_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_tcp_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_udp_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_udp_tnl_csum_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_udp_tnl_segmentation** *boolean* | **Choices:** `false`, `true` | +| • • • **tx_vlan_stag_hw_insert** *boolean* | **Choices:** `false`, `true` | +| • • • **txvlan** *boolean* | **Choices:** `false`, `true` | +| • • **ring** *dictionary* | A dictionary of `ethtool` `rx`/`tx` ring buffer entry counts. | +| • • • **rx** *integer* | The number of ring entries for the Rx ring. | +| • • • **rx_jumbo** *integer* | The number of ring entries for the Rx Jumbo ring. | +| • • • **rx_mini** *integer* | The number of ring entries for the Rx Mini ring. | +| • • • **tx** *integer* | The number of ring entries for the Tx ring. | +| • **force_state_change** *boolean* | Whether to force the runtime state change specified by `state` even when the role does not detect a difference between the requested and current configuration. Only meaningful together with `state`. **Choices:** `false`, `true` | +| • **ieee802_1x** *dictionary* | 802.1x authentication settings for `ethernet` or `wireless` interfaces. Only supported by the `nm` provider. `tls` is currently the only supported EAP method, and the certificates and keys it references must already be deployed on the host before running the role. | +| • • **ca_cert** *path* | The absolute path to the PEM encoded certificate authority used to verify the EAP server. | +| • • **ca_path** *path* | The absolute path to a directory of 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 together with `system_ca_certs`. | +| • • **client_cert** *path / required* | The absolute path to the client’s PEM encoded certificate. | +| • • **domain_suffix_match** *string* | A domain name suffix that must match the domain name in the EAP server’s certificate. | +| • • **eap** *string* | The EAP method used to authenticate to the network. **Choices:** `"tls"` (default) | +| • • **identity** *string / required* | The identity string for the EAP authentication method. | +| • • **private_key** *path / required* | The absolute path to the client’s PEM or PKCS#12 encoded private key. | +| • • **private_key_password** *string* | The password protecting `private_key`. | +| • • **private_key_password_flags** *list / elements=string* | Flags controlling how NetworkManager manages the private key password. See the “Secret flag types” section of `man 5 nm-settings` for details. **Choices:** `"none"`, `"agent-owned"`, `"not-saved"`, `"not-required"` | +| • • **system_ca_certs** *boolean* | Whether NetworkManager should use the system’s trusted CA certificates to verify the EAP server. **Choices:** `false` (default), `true` | +| • **ignore_errors** *boolean* | Whether to ignore errors that occur while applying this specific connection profile and continue applying the remaining profiles instead of failing the play. **Choices:** `false`, `true` | +| • **infiniband** *dictionary* | Settings for `infiniband` connections. Only supported by the `nm` provider. | +| • • **p_key** *integer* | The Infiniband P_Key to use for the device, a 16-bit unsigned integer with the high bit set for “full membership”. The values `0x0000` and `0x8000` are invalid. If set, `mac` or `parent` must also be set, and `interface_name` must be unset. When unset, the connection is created on the physical Infiniband fabric. | +| • • **transport_mode** *string* | The IP over Infiniband (ipoib) operation mode. **Choices:** `"datagram"` (default), `"connected"` | +| • **infiniband_p_key** *integer* | Deprecated alias for `infiniband.p_key`. Use the `infiniband` option instead. Cannot be combined with an `infiniband` dictionary. | +| • **infiniband_transport_mode** *string* | Deprecated alias for `infiniband.transport_mode`. Use the `infiniband` option instead. Cannot be combined with an `infiniband` dictionary. **Choices:** `"datagram"`, `"connected"` | +| • **interface_name** *string* | The name of the networking interface that the profile is restricted to or, for virtual devices, the name of the interface to create. Only allowed for `ethernet` and `infiniband` when `mac` is not set. Set to an empty string (`""`) to leave the profile unrestricted to a specific interface. Defaults to the profile `name` for most types, except that `bond`, `bridge`, `macvlan`, `team`, and `vlan` require an explicit `interface_name`. | +| • **ip** *dictionary* | The IP configuration of the profile. Ports of `bridge`, `bond`, or `team` devices cannot specify `ip` settings. | +| • • **address** *list / elements=any* | A list of static IP addresses to assign. Each item is either a string in `
      /` notation, for example `192.0.2.3/24`, or a dictionary with an `address` key and an optional `prefix` key. | +| • • **auto6** *boolean* | Whether to configure IPv6 addressing using StateLess Address Auto Configuration (SLAAC). If unset, defaults to `true` unless static IPv6 addresses are configured in `address`. **Choices:** `false`, `true` | +| • • **auto_gateway** *boolean* | Whether a default route should be configured using the automatically detected default gateway. Setting this to `false` is equivalent to `DEFROUTE=no` in initscripts or `ipv4.never-default`/ `ipv6.never-default` set to `yes` with `nmcli`. If enabled, at least one of `gateway4`, `gateway6`, or DHCP/SLAAC must be in use. **Choices:** `false`, `true` | +| • • **dhcp4** *boolean* | Whether to obtain an IPv4 address using DHCP. If unset, defaults to `true` unless static IPv4 addresses are configured in `address`. **Choices:** `false`, `true` | +| • • **dhcp4_send_hostname** *boolean* | Whether the DHCPv4 request should include the host’s name. Only valid when `dhcp4` is enabled. Only supported by the `nm` provider. **Choices:** `false`, `true` | +| • • **dns** *list / elements=string* | A list of name server IP addresses for manual DNS configuration, for example `192.0.2.2`. | +| • • **dns_options** *list / elements=string* | A list of DNS options as described in `man 5 resolv.conf`, for example `rotate` or `timeout:1`. Only supported by the `nm` provider. | +| • • **dns_priority** *integer* | The priority of the DNS servers configured on this connection. A lower numerical value has a higher priority. A negative value excludes name servers from connections with a higher (less negative) priority value when at least one negative priority is present. **Default:** `0` | +| • • **dns_search** *list / elements=string* | A list of DNS search domains for manual DNS configuration, for example `example.com`. | +| • • **gateway4** *string* | The default gateway for IPv4 packets, for example `192.0.2.1`. | +| • • **gateway6** *string* | The default gateway for IPv6 packets, for example `2001:db8::1`. | +| • • **ipv4_ignore_auto_dns** *boolean* | Whether to ignore IPv4 name servers and search domains obtained automatically (for example via DHCP) and only use the servers and domains specified in `dns` and `dns_search`. Not supported by the `initscripts` provider. **Choices:** `false`, `true` | +| • • **ipv6_disabled** *boolean* | Whether IPv6 should be disabled for the connection. Mutually exclusive with `auto6` enabled, static IPv6 addresses in `address`, `gateway6`, and `route_metric6`. **Choices:** `false`, `true` | +| • • **ipv6_ignore_auto_dns** *boolean* | Whether to ignore IPv6 name servers and search domains obtained automatically and only use the servers and domains specified in `dns` and `dns_search`. Not supported by the `initscripts` provider. **Choices:** `false`, `true` | +| • • **route** *list / elements=dictionary* | A list of static routes. | +| • • • **gateway** *string* | The gateway address for the route. Not allowed together with `type`. | +| • • • **metric** *integer* | The route metric. **Default:** `-1` | +| • • • **network** *string / required* | The destination network address of the route, for example `198.51.100.128`. Classless inter-domain routing (CIDR) and network mask notations are not supported here; use `prefix` instead. | +| • • • **prefix** *integer* | The prefix length of the destination network in `network`. Defaults to the address family’s full prefix length when not specified. | +| • • • **src** *string* | The source IP address to use for the route. | +| • • • **table** *any* | The routing table for the route, as a numeric table ID or the name of a table defined in `/etc/iproute2/rt_tables` or `/etc/iproute2/rt_tables.d/*.conf`. The role does not create these routing table definitions automatically. Not supported by the `initscripts` provider. | +| • • • **type** *string* | The route type. Routes of these types do not support a `gateway`. If not specified, the route is a regular unicast route. **Choices:** `"blackhole"`, `"prohibit"`, `"unreachable"` | +| • • **route_append_only** *boolean* | Whether to append the routes in `route` to the routes already present on the system instead of replacing them. Setting this to `true` without setting `route` preserves the current static routes. **Choices:** `false` (default), `true` | +| • • **route_metric4** *integer* | The route metric used for DHCP-assigned routes and the default IPv4 route, which also determines priority when multiple interfaces are configured. For `initscripts`, this sets the metric of the default route. | +| • • **route_metric6** *integer* | The route metric used for the default IPv6 route. Not supported by the `initscripts` provider. | +| • • **routing_rule** *list / elements=dictionary* | A list of policy routing rules, allowing packets to be routed based on fields other than the destination address. | +| • • • **action** *string* | The action to take when the rule matches. `table` is required when `action` is `to-table`. **Choices:** `"to-table"` (default), `"blackhole"`, `"prohibit"`, `"unreachable"` | +| • • • **dport** *any* | The destination port or port range to match, for example `1000-2000`. Accepts a single port number or a string in `-` notation, with valid ports ranging from 0 to 65534. | +| • • • **family** *string* | The IP family of the rule. Derived from `from` or `to` when not specified. **Choices:** `"ipv4"`, `"ipv6"` | +| • • • **from** *any* | The source address to match, for example `192.168.100.58/24`. Accepts a string in `
      /` notation or a dictionary with `address` and `prefix` keys. | +| • • • **fwmark** *integer* | The firewall mark value of the packet to match. Must be set together with `fwmask`. | +| • • • **fwmask** *integer* | The firewall mask value of the packet to match. Must be set together with `fwmark`. | +| • • • **iif** *string* | The name of the incoming interface to match. | +| • • • **invert** *boolean* | Whether to invert the match of the rule, so the rule matches any packet that does not satisfy the selected match. **Choices:** `false` (default), `true` | +| • • • **ipproto** *integer* | The IP protocol number to match. | +| • • • **oif** *string* | The name of the outgoing interface to match. | +| • • • **priority** *integer / required* | The priority of the rule. A lower numerical value means higher priority. | +| • • • **sport** *any* | The source port or port range to match, in the same format as `dport`. | +| • • • **suppress_prefixlength** *integer* | Reject routing decisions with a prefix length less than or equal to the specified value. Only allowed with the `to-table` action. | +| • • • **table** *any* | The routing table to look up for the `to-table` action, in the same format as `route.table`. | +| • • • **to** *any* | The destination address to match, in the same format as `from`. | +| • • • **tos** *integer* | The type-of-service value to match. | +| • • • **uid** *any* | The user ID or user ID range to match, in the same format as `dport`, with valid values ranging from 0 to 4294967295. | +| • • **rule_append_only** *boolean* | Whether to append the rules in `routing_rule` to the routing rules already present on the system instead of replacing them. **Choices:** `false` (default), `true` | +| • • **wait_ip** *string* | Which IP stack must be configured before the connection is considered activated. `any` waits for either stack, `ipv4` and `ipv6` wait for the respective stack, and `ipv4+ipv6` waits for both. **Choices:** `"any"` (default), `"ipv4"`, `"ipv6"`, `"ipv4+ipv6"` | +| • **mac** *string* | Restricts the profile to the device with the given hardware address. Only allowed for `type` `ethernet` (6 octets) or `infiniband` (20 octets). Specify the value in hexadecimal notation using colons, for example `"00:00:5e:00:53:5d"`, and quote it to avoid it being parsed as a sexagesimal number. | +| • **macvlan** *dictionary* | Settings for `macvlan` connections. | +| • • **mode** *string* | The MACVLAN mode. **Choices:** `"vepa"`, `"bridge"` (default), `"private"`, `"passthru"`, `"source"` | +| • • **promiscuous** *boolean* | Whether the underlying device is used in promiscuous mode. Can only be disabled (`false`) when `mode` is `passthru`. **Choices:** `false`, `true` (default) | +| • • **tap** *boolean* | Whether the device should be a MACVTAP device instead of a regular MACVLAN device. **Choices:** `false` (default), `true` | +| • **master** *string* | Deprecated alias for `controller`. Use `controller` instead. | +| • **match** *dictionary* | Settings used to match the profile against devices or systems, currently only supporting `path`. | +| • • **path** *list / elements=string* | A list of patterns to match against the `ID_PATH` udev property of a device, for example `pci-0000:00:03.0`. Supports the alternative (`\|`), mandatory (`&`), and inverted (`!`) modifiers, as well as `*`, `?`, and `[...]` shell-style wildcards. Only supported for `ethernet` or `infiniband` profiles. | +| • **mtu** *integer* | The maximum transmission unit of the profile’s device. The maximum allowed value depends on the device; for virtual devices it depends on the underlying device. | +| • **name** *string* | The name that identifies the connection profile. This is not necessarily the name of the networking interface, although a profile can be associated with an interface using the same name. For `NetworkManager`, this corresponds to `connection.id`. For `initscripts`, this determines the ifcfg file name `/etc/sysconfig/network-scripts/ifcfg-$NAME` and therefore cannot contain `/`. Required unless `persistent_state` is `absent`, in which case an empty `name` matches and removes every other profile. | +| • **parent** *string* | The `name` of another profile in **`network_connections`** that this profile’s device is created on top of. Used for `vlan`, `macvlan`, and `infiniband` (when `infiniband.p_key` is set). | +| • **persistent_state** *string* | Whether the connection profile should be saved on disk. `present` (the default) creates or updates the profile when `type` is also specified. `absent` deletes any profile matching `name`. **Choices:** `"present"`, `"absent"` | +| • **port_type** *string* | The type of the `controller` profile that this profile is a port of. Requires `controller` to be set. If not specified, it is derived from the type of the `controller` profile. **Choices:** `"bridge"`, `"bond"`, `"team"` | +| • **slave_type** *string* | Deprecated alias for `port_type`. Use `port_type` instead. **Choices:** `"bridge"`, `"bond"`, `"team"` | +| • **state** *string* | The runtime state of the connection profile. `up` activates the profile (equivalent to `nmcli connection up` or `ifup`) and `down` deactivates it (equivalent to `nmcli connection down` or `ifdown`). `present` and `absent` are accepted as aliases of the `persistent_state` values of the same name, but `state` and `persistent_state` cannot both be set on the same item. If unset, the runtime state is left unchanged. **Choices:** `"up"`, `"down"`, `"present"`, `"absent"` | +| • **type** *string* | The type of the connection profile. Providing `type` means the profile is completely specified; without it, only the runtime `state` of an existing profile can be changed. **Choices:** `"ethernet"`, `"infiniband"`, `"bridge"`, `"team"`, `"bond"`, `"vlan"`, `"macvlan"`, `"wireless"`, `"dummy"` | +| • **vlan** *dictionary* | Settings for `vlan` connections. | +| • • **id** *integer / required* | The VLAN ID, ranging from 0 to 4094. | +| • **vlan_id** *integer* | Deprecated alias for `vlan.id`. Use the `vlan` option instead. Cannot be combined with `vlan`. | +| • **wait** *float* | The number of seconds to wait for the device to finish activating when `state` is `up`. `0` starts the activation without waiting for completion, for example while a DHCP lease is obtained in the background. When unset, a suitable default timeout is used. Only supported by the `nm` provider and only meaningful together with `state`. | +| • **wireless** *dictionary* | Settings for `wireless` connections, supporting WPA-PSK, WPA-EAP (802.1x), WPA3-Personal SAE, and Enhanced Open (OWE) authentication. Only supported by the `nm` provider. | +| • • **key_mgmt** *string / required* | The key management method used to authenticate to the network. When `wpa-eap` is used, 802.1x settings must also be defined in `ieee802_1x`. **Choices:** `"owe"`, `"sae"`, `"wpa-eap"`, `"wpa-psk"` | +| • • **password** *string* | The password for the network. Required when `key_mgmt` is `wpa-psk` or `sae`, and not allowed otherwise. | +| • • **ssid** *string / required* | The SSID of the wireless network. | +| • **zone** *string* | The firewalld zone to associate with the interface. Ports of `bridge`, `bond`, or `team` devices cannot specify a zone. | +| **network_force_state_change** *boolean* | Whether to force the runtime state change requested by a profile’s `state` even when the role does not detect a difference between the requested and current configuration. Acts as the default for every item of **`network_connections`** that does not set its own `force_state_change`. **Choices:** `false`, `true` | +| **network_ignore_errors** *boolean* | Whether to ignore errors encountered while applying a connection profile and continue applying the remaining profiles instead of failing the play. Acts as the default for every item of **`network_connections`** that does not set its own `ignore_errors`. **Choices:** `false`, `true` | +| **network_state** *dictionary* | The desired network state to apply directly to the devices, using the [Nmstate](https://nmstate.io) schema (see the [Nmstate examples](https://nmstate.io/examples.html) and the [nmstate API documentation](https://docs.rs/nmstate/latest/nmstate/index.html)). When left empty, no state is applied. Only supported by the `nm` provider on RHEL 8 and later. Only the top-level keys are listed below; nmstate itself validates everything nested under them, so this role does not re-validate that content. **Default:** `{}` | +| • **description** *string* | A human-readable description of the whole desired state. Not persisted or applied by the network backend. | +| • **dns-resolver** *dictionary* | The desired DNS resolver configuration (search domains and servers). See the [Nmstate DNS resolver schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. Cannot be used while NetworkManager has a `[global-dns]` or `[global-dns-domain-*]` section configured. | +| • **hostname** *dictionary* | The desired hostname configuration. See the [Nmstate hostname schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | +| • **interfaces** *list / elements=dictionary* | The desired per-interface configuration (type, state, IP addressing, and type-specific settings such as bridge, bond, or VLAN options). See the [Nmstate interface schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | +| • **ovn** *dictionary* | The desired OVN (Open Virtual Network) mapping configuration. See the [Nmstate OVN schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | +| • **ovs-db** *dictionary* | The desired global Open vSwitch database configuration. See the [Nmstate OVS-DB schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | +| • **route-rules** *dictionary* | The desired routing rules. See the [Nmstate route rules schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | +| • **routes** *dictionary* | The desired static routes. See the [Nmstate routes schema](https://nmstate.io/devel/yaml_api.html) for its exact structure. | + +### Attributes + +| Attribute | Support | Description | +| -------------- | -------------------------------------------------------------------------------------------------- | --- | +| **check_mode** | **full** | The role can be run with `--check` to preview the changes it would make without applying them. Running with `--check` first is recommended before applying a new configuration. | +| **platform** | **Platforms:** **Fedora**, **EL**, **CentOS**, **RHEL**, **AlmaLinux**, **Rocky**, **OracleLinux** | Target operating systems. The role also supports distributions that it treats like RHEL, such as AlmaLinux, CentOS, OracleLinux, and Rocky. | + +### Notes + +- The `network_provider`, `network_provider_os_default`, `network_packages`, and `network_service_name` variables are intentionally not listed in the parameters below, even though they appear in `defaults/main.yml`. Their defaults depend on facts (such as `ansible_facts.services` and `ansible_facts.packages`) that are only gathered by this role’s own tasks. Ansible resolves the current value of every declared option when it validates role arguments, and it does so before the role’s own tasks (including its fact gathering) run. Declaring those variables here would force their fact-dependent defaults to be evaluated too early and break provider autodetection for the common case where the calling playbook has not already gathered service and package facts. + +- **`network_ignore_errors`** and **`network_force_state_change`** are not set in `defaults/main.yml` (they are left undefined so the `network_connections` module can apply its own static default), but they are documented, user-facing parameters read directly in `tasks/main.yml` and are listed in the parameters below. + +### Examples ```yaml - - name: eth0 - type: ethernet - # Specifying a connecting profile for an ethernet device only with the PCI address - # pci-0000:00:01.0 or pci-0000:00:03.0 - match: - path: - - pci-0000:00:0[1-3].0 - - &!pci-0000:00:02.0 - ip: - address: - - 192.0.2.3/24 +- name: Configure an Ethernet profile with full IPv4 and IPv6 settings + hosts: all + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + route_metric4: 100 + dhcp4: false + gateway4: 192.0.2.1 + dns: + - 192.0.2.2 + - 198.51.100.5 + dns_search: + - example.com + - subdomain.example.com + dns_options: + - rotate + - timeout:1 + route_metric6: -1 + auto6: false + gateway6: 2001:db8::1 + address: + - 192.0.2.3/24 + - 198.51.100.3/26 + - 2001:db8::80/7 + route: + - network: 198.51.100.128 + prefix: 26 + gateway: 198.51.100.1 + metric: 2 + - network: 198.51.100.64 + prefix: 26 + gateway: 198.51.100.6 + metric: 4 + route_append_only: false + rule_append_only: true + roles: + - linux-system-roles.network + +- name: Create a bridge with a bond attached to it + hosts: all + vars: + network_connections: + - name: internal-br0 + interface_name: br0 + type: bridge + ip: + dhcp4: false + auto6: false + - name: br0-bond0 + type: bond + interface_name: bond0 + controller: internal-br0 + port_type: bridge + - name: br0-bond0-eth1 + type: ethernet + interface_name: eth1 + controller: br0-bond0 + port_type: bond + roles: + - linux-system-roles.network + +- name: Configure a VLAN on top of an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth1-profile + autoconnect: false + type: ethernet + interface_name: eth1 + ip: + dhcp4: false + auto6: false + - name: eth1.6 + autoconnect: false + type: vlan + parent: eth1-profile + vlan: + id: 6 + ip: + address: + - 192.0.2.5/24 + auto6: false + roles: + - linux-system-roles.network + +- name: Configure a MACVLAN on top of an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth0-profile + type: ethernet + interface_name: eth0 + ip: + address: + - 192.168.0.1/24 + - name: veth0 + type: macvlan + parent: eth0-profile + macvlan: + mode: bridge + promiscuous: true + tap: false + ip: + address: + - 192.168.1.1/24 + roles: + - linux-system-roles.network + +- name: Configure a WPA-PSK wireless connection + hosts: all + vars: + network_connections: + - name: wlan0 + type: wireless + wireless: + ssid: "My WPA2-PSK Network" + key_mgmt: "wpa-psk" + # recommend vault encrypting the wireless password + password: "{{ vault_wifi_password }}" + roles: + - linux-system-roles.network + +- name: Configure 802.1x (EAP-TLS) authentication on an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth0 + type: ethernet + ieee802_1x: + identity: myhost + eap: tls + private_key: /etc/pki/tls/client.key + # recommend vault encrypting the private key password + private_key_password: "{{ vault_private_key_password }}" + client_cert: /etc/pki/tls/client.pem + ca_cert: /etc/pki/tls/cacert.pem + domain_suffix_match: example.com + roles: + - linux-system-roles.network + +- name: Apply IP addresses directly to devices with network_state + hosts: all + vars: + network_state: + interfaces: + - name: ethtest0 + type: ethernet + state: up + ipv4: + enabled: true + address: + - ip: 192.168.122.250 + prefix-length: 24 + dhcp: false + ipv6: + enabled: true + address: + - ip: 2001:db8::1:1 + prefix-length: 64 + autoconf: false + dhcp: false + roles: + - linux-system-roles.network + +- name: Configure a static route with network_state + hosts: all + vars: + network_state: + interfaces: + - name: eth1 + type: ethernet + state: up + ipv4: + enabled: true + address: + - ip: 192.0.2.251 + prefix-length: 24 + dhcp: false + routes: + config: + - destination: 198.51.100.0/24 + metric: 150 + next-hop-address: 192.0.2.251 + next-hop-interface: eth1 + table-id: 254 + roles: + - linux-system-roles.network + +- name: Configure DNS search domains and servers with network_state + hosts: all + vars: + network_state: + dns-resolver: + config: + search: + - example.com + - example.org + server: + - 2001:4860:4860::8888 + - 8.8.8.8 + roles: + - linux-system-roles.network ``` -Deleting a connection profile named `eth0` (if it exists): - -```yaml -network_connections: - - name: eth0 - persistent_state: absent -``` - -Configuring the Ethernet link settings: - -```yaml -network_connections: - - name: eth0 - type: ethernet - - ethernet: - autoneg: false - speed: 1000 - duplex: full -``` - -Creating a bridge connection: - -```yaml -network_connections: - - name: br0 - type: bridge - #interface_name: br0 # defaults to the connection name -``` - -Configuring a bridge connection: - -```yaml -network_connections: - - name: internal-br0 - interface_name: br0 - type: bridge - ip: - dhcp4: false - auto6: false -``` - -Setting `controller` and `port_type`: - -```yaml -network_connections: - - name: br0-bond0 - type: bond - interface_name: bond0 - controller: internal-br0 - port_type: bridge - - - name: br0-bond0-eth1 - type: ethernet - interface_name: eth1 - controller: br0-bond0 - port_type: bond -``` - -Configuring VLANs: - -```yaml -network_connections: - - name: eth1-profile - autoconnect: false - type: ethernet - interface_name: eth1 - ip: - dhcp4: false - auto6: false - - - name: eth1.6 - autoconnect: false - type: vlan - parent: eth1-profile - vlan: - id: 6 - ip: - address: - - 192.0.2.5/24 - auto6: false -``` - -Configuring MACVLAN: - -```yaml -network_connections: - - name: eth0-profile - type: ethernet - interface_name: eth0 - ip: - address: - - 192.168.0.1/24 - - - name: veth0 - type: macvlan - parent: eth0-profile - macvlan: - mode: bridge - promiscuous: true - tap: false - ip: - address: - - 192.168.1.1/24 -``` - -Configuring a wireless connection: - -```yaml -network_connections: - - name: wlan0 - type: wireless - wireless: - ssid: "My WPA2-PSK Network" - key_mgmt: "wpa-psk" - # recommend vault encrypting the wireless password - # see https://docs.ansible.com/ansible/latest/user_guide/vault.html - password: "p@55w0rD" -``` - -Setting the IP configuration: - -```yaml -network_connections: - - name: eth0 - type: ethernet - ip: - route_metric4: 100 - dhcp4: false - #dhcp4_send_hostname: false - gateway4: 192.0.2.1 - - dns: - - 192.0.2.2 - - 198.51.100.5 - dns_search: - - example.com - - subdomain.example.com - dns_options: - - rotate - - timeout:1 - - route_metric6: -1 - auto6: false - gateway6: 2001:db8::1 - - address: - - 192.0.2.3/24 - - 198.51.100.3/26 - - 2001:db8::80/7 - - route: - - network: 198.51.100.128 - prefix: 26 - gateway: 198.51.100.1 - metric: 2 - - network: 198.51.100.64 - prefix: 26 - gateway: 198.51.100.6 - metric: 4 - route_append_only: false - rule_append_only: true -``` - -Configuring 802.1x: - -```yaml -network_connections: - - name: eth0 - type: ethernet - ieee802_1x: - identity: myhost - eap: tls - private_key: /etc/pki/tls/client.key - # recommend vault encrypting the private key password - # see https://docs.ansible.com/ansible/latest/user_guide/vault.html - private_key_password: "p@55w0rD" - client_cert: /etc/pki/tls/client.pem - ca_cert: /etc/pki/tls/cacert.pem - domain_suffix_match: example.com -``` - -Configuring Enhanced Open(OWE): - -```yaml -network_connections: - - name: wlan0 - type: wireless - wireless: - ssid: "WIFI_SSID" - key_mgmt: "owe" -``` - -## Examples of Applying the Network State Configuration - -Configuring the IP addresses: - -```yaml -network_state: - interfaces: - - name: ethtest0 - type: ethernet - state: up - ipv4: - enabled: true - address: - - ip: 192.168.122.250 - prefix-length: 24 - dhcp: false - ipv6: - enabled: true - address: - - ip: 2001:db8::1:1 - prefix-length: 64 - autoconf: false - dhcp: false - - name: ethtest1 - type: ethernet - state: up - ipv4: - enabled: true - address: - - ip: 192.168.100.192 - prefix-length: 24 - auto-dns: false - dhcp: false - ipv6: - enabled: true - address: - - ip: 2001:db8::2:1 - prefix-length: 64 - autoconf: false - dhcp: false -``` - -Configuring the Linux bridge with custom multicast, stp options, along with a port -with specific stp settings: - -```yaml -network_state: - interfaces: - - name: br0 - type: linux-bridge - state: up - bridge: - options: - gc-timer: 29657 - group-addr: 01:80:C2:00:00:00 - group-forward-mask: 0 - group-fwd-mask: 0 - hash-max: 4096 - hello-timer: 0 - mac-ageing-time: 300 - multicast-last-member-count: 2 - multicast-last-member-interval: 100 - multicast-membership-interval: 26000 - multicast-querier: false - multicast-querier-interval: 25500 - multicast-query-interval: 12500 - multicast-query-response-interval: 1000 - multicast-query-use-ifaddr: false - multicast-router: auto - multicast-snooping: true - multicast-startup-query-count: 2 - multicast-startup-query-interval: 3125 - stp: - enabled: false - forward-delay: 15 - hello-time: 2 - max-age: 20 - priority: 32768 - vlan-protocol: 802.1q - port: - - name: eth1 - stp-hairpin-mode: false - stp-path-cost: 100 - stp-priority: 32 -``` - -Configuring the route: - -```yaml -network_state: - interfaces: - - name: eth1 - type: ethernet - state: up - ipv4: - enabled: true - address: - - ip: 192.0.2.251 - prefix-length: 24 - dhcp: false - - routes: - config: - - destination: 198.51.100.0/24 - metric: 150 - next-hop-address: 192.0.2.251 - next-hop-interface: eth1 - table-id: 254 -``` - -Configuring the DNS search and server: - -```yaml -network_state: - dns-resolver: - config: - search: - - example.com - - example.org - server: - - 2001:4860:4860::8888 - - 8.8.8.8 -``` - -### Invalid and Wrong Configuration - -The `network` role rejects invalid configurations. It is recommended to test the role -with `--check` first. There is no protection against wrong (but valid) configuration. -Double-check your configuration before applying it. - -### network_connections Internal Module - -The `network_connections` internal module is intended for internal use or integration -testing and is not intended for direct external access or use. When this internal -module is utilized in integration tests, the tasks specified in `tasks/main.yaml` -are skipped, thereby speeding up the test execution. - -## 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 -and initscripts. However, note that not every option is handled exactly the same -by every provider. Do a test run first with `--check`. - -It is not supported to create a configuration for one provider, and expect another -provider to handle them. For example, creating profiles with the `initscripts` provider, -and later enabling NetworkManager is not guaranteed to work automatically. Possibly, -you have to adjust the configuration so that it can be used by another provider. - -For example, configuring a RHEL6 host with initscripts and upgrading to -RHEL7 while continuing to use initscripts in RHEL7 is an acceptable scenario. What -is not guaranteed is to upgrade to RHEL7, disable initscripts and expect NetworkManager -to take over the configuration automatically. - -Depending on NetworkManager's configuration, connections may be stored as ifcfg files -as well, but it is not guaranteed that plain initscripts can handle these ifcfg files -after disabling the NetworkManager service. - -The `network` role also supports configuring in certain Ansible distributions that the -role treats like RHEL, such as AlmaLinux, CentOS, OracleLinux, Rocky. - -## Limitations - -As Ansible usually works via the network, for example via SSH, there are some -limitations to be considered: - -The `network` role does not support bootstrapping networking configuration. One option -may be -[ansible-pull](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html). -Another option maybe be to initially auto-configure the host during installation (ISO -based, kickstart, etc.), so that the host is connected to a management LAN or VLAN. It -strongly depends on your environment. - -For `initscripts` provider, deploying a profile merely means to create the ifcfg -files. Nothing happens automatically until the play issues `ifup` or `ifdown` -via the `up` or `down` [states](#state) -- unless there are other -components that rely on the ifcfg files and react on changes. - -The `initscripts` provider requires the different profiles to be in the right -order when they depend on each other. For example the bonding controller device -needs to be specified before the port devices. - -When removing a profile for NetworkManager it also takes the connection -down and possibly removes virtual interfaces. With the `initscripts` provider -removing a profile does not change its current runtime state (this is a future -feature for NetworkManager as well). - -For NetworkManager, modifying a connection with autoconnect enabled may result in the -activation of a new profile on a previously disconnected interface. Also, deleting a -NetworkManager connection that is currently active results in removing the interface. -Therefore, the order of the steps should be followed, and carefully handling of -[autoconnect](#autoconnect) property may be necessary. This should be improved in -NetworkManager RFE [rh#1401515](https://bugzilla.redhat.com/show_bug.cgi?id=1401515). - -It seems difficult to change networking of the target host in a way that breaks -the current SSH connection of ansible. If you want to do that, ansible-pull might -be a solution. Alternatively, a combination of `async`/`poll` with changing -the `ansible_host` midway of the play. - -**TODO** The current role does not yet support to easily split the -play in a pre-configure step, and a second step to activate the new configuration. - -In general, to successfully run the play, determine which configuration is -active in the first place, and then carefully configure a sequence of steps to change to -the new configuration. The actual solution depends strongly on your environment. - -Routing rules and named routing tables are not supported when using the -`initscripts` provider. If `network_provider: initscripts` is set, any -`routing_rule` entries and named `table` references in `route` will be -silently ignored. Use `network_provider: nm` (NetworkManager) for routing -rule support. - -Configuring `dns-resolver` through `network_state` is not supported when -NetworkManager has a `[global-dns]` or `[global-dns-domain-*]` section in its -configuration files (`/etc/NetworkManager/NetworkManager.conf` or a `conf.d` -snippet). nmstate applies DNS through NetworkManager's D-Bus global DNS API, and -NetworkManager rejects that while global DNS is set in a configuration file. The -role fails with an error naming the file. Either remove the section and reload -NetworkManager, or configure DNS on the connection profiles instead of -`dns-resolver`. - -### Handling potential problems - -When something goes wrong while configuring networking remotely, you might need -to get physical access to the machine to recover. - -**TODO** NetworkManager supports a -[checkpoint/rollback](https://developer.gnome.org/NetworkManager/stable/gdbus-org.freedesktop.NetworkManager.html#gdbus-method-org-freedesktop-NetworkManager.CheckpointCreate) -feature. At the beginning of the play we could create a checkpoint and if we lose -connectivity due to an error, NetworkManager would automatically rollback after -timeout. The limitations is that this would only work with NetworkManager, and -it is not clear that rollback will result in a working configuration. - -*Want to contribute? Take a look at our [contributing -guidelines](https://github.com/linux-system-roles/network/blob/main/contributing.md)!* +### Authors -## rpm-ostree +- Thomas Haller -See README-ostree.md +- Till Maas diff --git a/meta/argument_specs.yml b/meta/argument_specs.yml new file mode 100644 index 000000000..7f2065555 --- /dev/null +++ b/meta/argument_specs.yml @@ -0,0 +1,1674 @@ +# SPDX-License-Identifier: BSD-3-Clause +--- +argument_specs: + main: + short_description: Configure networking + # description renders as the "Synopsis" at the top of the page. Use it for + # the role summary and all the narrative a reader should see up front: + # providers, the two configuration mechanisms, requirements, warnings, + # compatibility, and limitations. Each list item becomes one bullet. Keep + # low-level implementation details out of here (put them in notes). + description: + - > + The C(network) role configures network interfaces and IP + settings on the target machines. It can configure Ethernet, + bridge, bonded, VLAN, MacVLAN, Infiniband, wireless (WiFi), and + dummy interfaces, IP configuration, and 802.1x authentication. + - > + The role supports two providers, V(nm) (NetworkManager) and + V(initscripts). V(nm) is used by default since RHEL 7 and + V(initscripts) on RHEL 6. The V(initscripts) provider requires + the C(network-scripts) package, which is deprecated in RHEL 8 + and dropped in RHEL 9. The provider is autodetected per host + from the distribution unless set explicitly with the + C(network_provider) variable. Neither provider is tied to a + distribution: V(nm) works wherever NetworkManager API version + 1.2 or later is available, and some settings require a newer + API version. + - > + Two mechanisms are available to configure networking. The + O(network_connections) variable manages connection profiles + (one list item per profile) and is supported by both providers. + The O(network_state) variable applies an Nmstate desired state + directly to the devices and is only supported by the V(nm) + provider on RHEL 8 and later. + - > + Because its backend is Nmstate, O(network_state) represents the + future direction of the role, aiming to provide a more + streamlined and reliable way to manage networking; most + features available in NetworkManager are also available through + it. For the Nmstate schema, syntax, and examples, see + L(nmstate.io,https://nmstate.io) and the L(nmstate API + documentation,https://docs.rs/nmstate/latest/nmstate/index.html). + - > + B(Warning): the C(network) role updates or creates all + connection profiles listed in O(network_connections) on the + target system, and it removes options that are present on the + system but not in O(network_connections). Partial configuration + can instead be achieved with O(network_state). + - > + Collection requirements: to manage C(rpm-ostree) nodes, the role + requires additional modules from external collections; install + them with C(ansible-galaxy collection install -vv -r + meta/collection-requirements.yml). To manage other systems, the + role has no additional requirements. + - > + The role operates both on the connection profiles of devices + (via O(network_connections)) and on devices directly (via + O(network_state)). You can create generic profiles, for example + a profile with a certain IP configuration, without activating + them, then apply the configuration to the interface with + C(nmcli) on the target system. + - > + Compatibility: both providers share the same configuration + scheme, so the same playbook can be used with NetworkManager and + initscripts. Not every option is handled identically by both + providers, so do a test run with C(--check) first. Creating a + configuration with one provider and expecting another provider + to handle it is not supported. The role also supports + distributions that it treats like RHEL, such as AlmaLinux, + CentOS, OracleLinux, and Rocky. + - > + Invalid versus wrong configuration: the role rejects invalid + configurations (test with C(--check) first), but there is no + protection against configuration that is valid but wrong. + Double-check your configuration before applying it. + - > + Limitations: the role does not bootstrap networking (consider + L(ansible-pull,https://docs.ansible.com/ansible/latest/cli/ansible-pull.html) + or auto-configuring the host during installation). For the + V(initscripts) provider, deploying a profile only writes the + ifcfg files; nothing happens until an C(up) or C(down) state + issues C(ifup) or C(ifdown). The V(initscripts) provider + requires dependent profiles in the right order, for example a + bonding controller before its ports. Removing a NetworkManager + profile also takes the connection down and may remove virtual + interfaces, while removing an V(initscripts) profile does not + change the current runtime state. For NetworkManager, modifying + a connection with autoconnect enabled may activate a new + profile, and deleting a connection that is currently active + removes the interface, so order the steps and handle the + C(autoconnect) property carefully (see + L(rh#1401515,https://bugzilla.redhat.com/show_bug.cgi?id=1401515)). + - > + Routing rules and named routing tables are not supported with + the V(initscripts) provider: if C(network_provider) is set to + V(initscripts), C(routing_rule) entries and named C(table) + references in C(route) are silently ignored. Use the V(nm) + provider for routing rule support. + - > + Configuring C(dns-resolver) through O(network_state) is not + supported when NetworkManager has a C([global-dns]) or + C([global-dns-domain-*]) section in its configuration files + (C(/etc/NetworkManager/NetworkManager.conf) or a C(conf.d) + snippet). nmstate applies DNS through NetworkManager's global DNS + API, which NetworkManager rejects while global DNS is set in a + configuration file; the role then fails with an error naming the + file. Either remove the section and reload NetworkManager, or + configure DNS on the connection profiles instead of + C(dns-resolver). + - > + The C(network_connections) module is intended for internal use + and integration testing only, and is not intended for direct + external use. + - 'For C(rpm-ostree) systems, see the C(README-ostree.md) file in the role.' + author: + - Thomas Haller + - Till Maas + # notes renders as the "Notes" section near the bottom of the page. Reserve + # it for low-level, implementation-level details that do not belong in the + # Synopsis - for example how fact-dependent defaults are resolved, or (in + # other roles) the variables the role returns. Each list item becomes one + # bullet. + notes: + - > + The C(network_provider), C(network_provider_os_default), + C(network_packages), and C(network_service_name) variables are + intentionally not listed in the parameters below, even though + they appear in C(defaults/main.yml). Their defaults depend on + facts (such as C(ansible_facts.services) and + C(ansible_facts.packages)) that are only gathered by this role's + own tasks. Ansible resolves the current value of every declared + option when it validates role arguments, and it does so before + the role's own tasks (including its fact gathering) run. + Declaring those variables here would force their fact-dependent + defaults to be evaluated too early and break provider + autodetection for the common case where the calling playbook has + not already gathered service and package facts. + - > + O(network_ignore_errors) and O(network_force_state_change) are + not set in C(defaults/main.yml) (they are left undefined so the + C(network_connections) module can apply its own static default), + but they are documented, user-facing parameters read directly in + C(tasks/main.yml) and are listed in the parameters below. + # attributes renders as the "Attributes" table. Use it for support + # information such as which platforms the role supports and whether it + # supports check mode. Every attribute requires a "support" value. + attributes: + check_mode: + support: full + description: > + The role can be run with C(--check) to preview the changes it + would make without applying them. Running with C(--check) + first is recommended before applying a new configuration. + platform: + support: full + platforms: + - Fedora + - EL + - CentOS + - RHEL + - AlmaLinux + - Rocky + - OracleLinux + description: > + Target operating systems. The role also supports distributions + that it treats like RHEL, such as AlmaLinux, CentOS, + OracleLinux, and Rocky. + # options renders as the "Parameters" table. List every role variable + # here with its type, default, choices, and description. Nested options + # (options within options) render as nested rows. + options: + network_connections: + type: list + elements: dict + default: [] + description: > + A list of connection profile specifications to create, + modify, activate, or remove. Profiles referenced by + C(controller) or C(parent) must appear earlier in the list than + the profile referencing them. To remove every profile on the + system that is not otherwise listed, add an item with no + C(name) and C(persistent_state) set to V(absent). + options: + name: + type: str + description: > + The name that identifies the connection profile. This is + not necessarily the name of the networking interface, + although a profile can be associated with an interface + using the same name. For C(NetworkManager), this + corresponds to C(connection.id). For V(initscripts), this + determines the ifcfg file name + C(/etc/sysconfig/network-scripts/ifcfg-$NAME) and + therefore cannot contain C(/). Required unless + C(persistent_state) is V(absent), in which case an empty + C(name) matches and removes every other profile. + state: + type: str + choices: + - up + - down + - present + - absent + description: > + The runtime state of the connection profile. V(up) + activates the profile (equivalent to C(nmcli connection up) + or C(ifup)) and V(down) deactivates it (equivalent to + C(nmcli connection down) or C(ifdown)). V(present) and + V(absent) are accepted as aliases of the C(persistent_state) + values of the same name, but C(state) and + C(persistent_state) cannot both be set on the same item. + If unset, the runtime state is left unchanged. + persistent_state: + type: str + choices: + - present + - absent + description: > + Whether the connection profile should be saved on disk. + V(present) (the default) creates or updates the profile + when C(type) is also specified. V(absent) deletes any + profile matching C(name). + force_state_change: + type: bool + description: > + Whether to force the runtime state change specified by + C(state) even when the role does not detect a difference + between the requested and current configuration. Only + meaningful together with C(state). + wait: + type: float + description: > + The number of seconds to wait for the device to finish + activating when C(state) is V(up). V(0) starts the + activation without waiting for completion, for example + while a DHCP lease is obtained in the background. + When unset, a suitable default timeout is used. Only + supported by the V(nm) provider and only meaningful + together with C(state). + type: + type: str + choices: + - ethernet + - infiniband + - bridge + - team + - bond + - vlan + - macvlan + - wireless + - dummy + description: > + The type of the connection profile. Providing C(type) + means the profile is completely specified; without it, + only the runtime C(state) of an existing profile can be + changed. + autoconnect: + type: bool + default: true + description: > + Whether the profile is activated automatically. For + C(NetworkManager), this corresponds to + C(connection.autoconnect). For V(initscripts), this + corresponds to C(ONBOOT). + autoconnect_retries: + type: int + default: -1 + description: > + The number of times to try autoactivating the connection + before giving up. V(0) means try forever, and V(-1) uses + the NetworkManager global default (normally 4 tries). + V(1) tries activation only once before blocking + autoconnect until the next attempt to autoconnect. + Only supported by the V(nm) provider. + port_type: + type: str + choices: + - bridge + - bond + - team + description: > + The type of the C(controller) profile that this profile is + a port of. Requires C(controller) to be set. If not + specified, it is derived from the type of the + C(controller) profile. + slave_type: # wokeignore:rule=slave + type: str + choices: + - bridge + - bond + - team + description: > + Deprecated alias for C(port_type). Use C(port_type) instead. + controller: + type: str + description: > + The C(name) of another profile in O(network_connections) + that this profile is a port of, used for V(bridge), + V(bond), and V(team) controller devices. This refers to a + profile name in the play, not an interface name or + NetworkManager connection ID. Ports must not specify C(ip) + or C(zone) settings. + master: + type: str + description: > + Deprecated alias for C(controller). Use C(controller) + instead. + interface_name: + type: str + description: > + The name of the networking interface that the profile is + restricted to or, for virtual devices, the name of the + interface to create. Only allowed for V(ethernet) and + V(infiniband) when C(mac) is not set. Set to an empty string + (V("")) to leave the profile unrestricted to a specific + interface. Defaults to the profile C(name) for most types, + except that V(bond), V(bridge), V(macvlan), V(team), and + V(vlan) require an explicit C(interface_name). + mac: + type: str + description: > + Restricts the profile to the device with the given + hardware address. Only allowed for C(type) V(ethernet) + (6 octets) or V(infiniband) (20 octets). Specify the value + in hexadecimal notation using colons, for example + V("00:00:5e:00:53:5d"), and quote it to avoid it being + parsed as a sexagesimal number. + cloned_mac: + type: str + default: default + description: > + The MAC address strategy to apply on activation. Accepts + a hardware address in the same notation as C(mac), or one + of the special values V(default) (honor the NetworkManager + default), V(permanent) (use the device's permanent + address), V(preserve) (do not change the current address), + V(random) (generate a new address on every connect), or + V(stable) (generate a stable, hashed address). + mtu: + type: int + description: > + The maximum transmission unit of the profile's device. + The maximum allowed value depends on the device; for + virtual devices it depends on the underlying device. + zone: + type: str + description: > + The firewalld zone to associate with the interface. Ports + of V(bridge), V(bond), or V(team) devices cannot specify a + zone. + check_iface_exists: + type: bool + default: true + description: > + Whether to check that the target interface exists before + activating the connection. Only supported by the V(nm) + provider. + parent: + type: str + description: > + The C(name) of another profile in O(network_connections) + that this profile's device is created on top of. Used for + V(vlan), V(macvlan), and V(infiniband) (when + C(infiniband.p_key) is set). + ignore_errors: + type: bool + description: > + Whether to ignore errors that occur while applying this + specific connection profile and continue applying the + remaining profiles instead of failing the play. + vlan_id: + type: int + description: > + Deprecated alias for C(vlan.id). Use the C(vlan) option + instead. Cannot be combined with C(vlan). + infiniband_transport_mode: + type: str + choices: + - datagram + - connected + description: > + Deprecated alias for C(infiniband.transport_mode). Use the + C(infiniband) option instead. Cannot be combined with an + C(infiniband) dictionary. + infiniband_p_key: + type: int + description: > + Deprecated alias for C(infiniband.p_key). Use the + C(infiniband) option instead. Cannot be combined with an + C(infiniband) dictionary. + match: + type: dict + description: > + Settings used to match the profile against devices or + systems, currently only supporting C(path). + options: + path: + type: list + elements: str + description: > + A list of patterns to match against the C(ID_PATH) + udev property of a device, for example + V(pci-0000:00:03.0). Supports the alternative (C(|)), + mandatory (C(&)), and inverted (C(!)) modifiers, as well + as C(*), C(?), and C([...]) shell-style wildcards. Only + supported for V(ethernet) or V(infiniband) profiles. + ip: + type: dict + description: > + The IP configuration of the profile. Ports of V(bridge), + V(bond), or V(team) devices cannot specify C(ip) settings. + options: + dhcp4: + type: bool + description: > + Whether to obtain an IPv4 address using DHCP. If + unset, defaults to V(true) unless static IPv4 + addresses are configured in C(address). + dhcp4_send_hostname: + type: bool + description: > + Whether the DHCPv4 request should include the host's + name. Only valid when C(dhcp4) is enabled. Only + supported by the V(nm) provider. + gateway4: + type: str + description: > + The default gateway for IPv4 packets, for example + V(192.0.2.1). + route_metric4: + type: int + description: > + The route metric used for DHCP-assigned routes and + the default IPv4 route, which also determines + priority when multiple interfaces are configured. For + V(initscripts), this sets the metric of the default + route. + auto6: + type: bool + description: > + Whether to configure IPv6 addressing using StateLess + Address Auto Configuration (SLAAC). If unset, defaults + to V(true) unless static IPv6 addresses are configured + in C(address). + ipv4_ignore_auto_dns: + type: bool + description: > + Whether to ignore IPv4 name servers and search + domains obtained automatically (for example via DHCP) + and only use the servers and domains specified in + C(dns) and C(dns_search). Not supported by the + V(initscripts) provider. + ipv6_ignore_auto_dns: + type: bool + description: > + Whether to ignore IPv6 name servers and search + domains obtained automatically and only use the + servers and domains specified in C(dns) and + C(dns_search). Not supported by the V(initscripts) + provider. + wait_ip: + type: str + choices: + - any + - ipv4 + - ipv6 + - ipv4+ipv6 + default: any + description: > + Which IP stack must be configured before the + connection is considered activated. V(any) waits for + either stack, V(ipv4) and V(ipv6) wait for the + respective stack, and V(ipv4+ipv6) waits for both. + ipv6_disabled: + type: bool + description: > + Whether IPv6 should be disabled for the connection. + Mutually exclusive with C(auto6) enabled, static IPv6 + addresses in C(address), C(gateway6), and + C(route_metric6). + gateway6: + type: str + description: > + The default gateway for IPv6 packets, for example + V(2001:db8::1). + route_metric6: + type: int + description: > + The route metric used for the default IPv6 route. + Not supported by the V(initscripts) provider. + address: + type: list + elements: raw + description: > + A list of static IP addresses to assign. Each item is + either a string in C(
      /) notation, for + example V(192.0.2.3/24), or a dictionary with an + C(address) key and an optional C(prefix) key. + auto_gateway: + type: bool + description: > + Whether a default route should be configured using + the automatically detected default gateway. Setting + this to V(false) is equivalent to C(DEFROUTE=no) in + initscripts or C(ipv4.never-default)/ + C(ipv6.never-default) set to V(yes) with C(nmcli). If + enabled, at least one of C(gateway4), C(gateway6), or + DHCP/SLAAC must be in use. + route: + type: list + elements: dict + description: > + A list of static routes. + options: + network: + type: str + required: true + description: > + The destination network address of the route, for + example V(198.51.100.128). Classless inter-domain + routing (CIDR) and network mask notations are not + supported here; use C(prefix) instead. + prefix: + type: int + description: > + The prefix length of the destination network in + C(network). Defaults to the address family's full + prefix length when not specified. + gateway: + type: str + description: > + The gateway address for the route. Not allowed + together with C(type). + metric: + type: int + default: -1 + description: > + The route metric. + type: + type: str + choices: + - blackhole + - prohibit + - unreachable + description: > + The route type. Routes of these types do not + support a C(gateway). If not specified, the route + is a regular unicast route. + table: + type: raw + description: > + The routing table for the route, as a numeric + table ID or the name of a table defined in + C(/etc/iproute2/rt_tables) or + C(/etc/iproute2/rt_tables.d/*.conf). The role does + not create these routing table definitions + automatically. Not supported by the + V(initscripts) provider. + src: + type: str + description: > + The source IP address to use for the route. + route_append_only: + type: bool + default: false + description: > + Whether to append the routes in C(route) to the routes + already present on the system instead of replacing + them. Setting this to V(true) without setting C(route) + preserves the current static routes. + rule_append_only: + type: bool + default: false + description: > + Whether to append the rules in C(routing_rule) to the + routing rules already present on the system instead + of replacing them. + dns: + type: list + elements: str + description: > + A list of name server IP addresses for manual DNS + configuration, for example V(192.0.2.2). + dns_search: + type: list + elements: str + description: > + A list of DNS search domains for manual DNS + configuration, for example V(example.com). + dns_options: + type: list + elements: str + description: > + A list of DNS options as described in + C(man 5 resolv.conf), for example V(rotate) or + V(timeout:1). Only supported by the V(nm) provider. + dns_priority: + type: int + default: 0 + description: > + The priority of the DNS servers configured on this + connection. A lower numerical value has a higher + priority. A negative value excludes name servers from + connections with a higher (less negative) priority + value when at least one negative priority is present. + routing_rule: + type: list + elements: dict + description: > + A list of policy routing rules, allowing packets to + be routed based on fields other than the destination + address. + options: + priority: + type: int + required: true + description: > + The priority of the rule. A lower numerical value + means higher priority. + action: + type: str + choices: + - to-table + - blackhole + - prohibit + - unreachable + default: to-table + description: > + The action to take when the rule matches. C(table) + is required when C(action) is V(to-table). + dport: + type: raw + description: > + The destination port or port range to match, for + example V(1000-2000). Accepts a single port number + or a string in C(-) notation, with + valid ports ranging from 0 to 65534. + family: + type: str + choices: + - ipv4 + - ipv6 + description: > + The IP family of the rule. Derived from C(from) or + C(to) when not specified. + from: + type: raw + description: > + The source address to match, for example + V(192.168.100.58/24). Accepts a string in + C(
      /) notation or a dictionary with + C(address) and C(prefix) keys. + fwmark: + type: int + description: > + The firewall mark value of the packet to match. + Must be set together with C(fwmask). + fwmask: + type: int + description: > + The firewall mask value of the packet to match. + Must be set together with C(fwmark). + iif: + type: str + description: > + The name of the incoming interface to match. + invert: + type: bool + default: false + description: > + Whether to invert the match of the rule, so the + rule matches any packet that does not satisfy the + selected match. + ipproto: + type: int + description: > + The IP protocol number to match. + oif: + type: str + description: > + The name of the outgoing interface to match. + sport: + type: raw + description: > + The source port or port range to match, in the + same format as C(dport). + suppress_prefixlength: + type: int + description: > + Reject routing decisions with a prefix length + less than or equal to the specified value. Only + allowed with the V(to-table) action. + table: + type: raw + description: > + The routing table to look up for the V(to-table) + action, in the same format as C(route.table). + to: + type: raw + description: > + The destination address to match, in the same + format as C(from). + tos: + type: int + description: > + The type-of-service value to match. + uid: + type: raw + description: > + The user ID or user ID range to match, in the + same format as C(dport), with valid values ranging + from 0 to 4294967295. + ethernet: + type: dict + description: > + Ethernet link settings, corresponding to the C(ethtool) + utility's link settings. Only allowed for V(ethernet), + V(vlan), V(bridge), V(bond), and V(team) types. + options: + autoneg: + type: bool + description: > + Whether auto-negotiation is enabled. When C(speed) or + C(duplex) are set, C(autoneg) must not be enabled, and + when it is disabled, both C(speed) and C(duplex) must be + set. + speed: + type: int + default: 0 + description: > + The link speed in Mbit/s. Required together with + C(duplex) when C(autoneg) is disabled. + duplex: + type: str + choices: + - half + - full + description: > + The link duplex mode. Required together with C(speed) + when C(autoneg) is disabled. + ethtool: + type: dict + description: > + Settings to enable or disable C(ethtool) features on the + device. Depending on the kernel and device, some settings + might not be supported. + options: + features: + type: dict + description: > + A dictionary that enables (V(true)) or disables + (V(false)) individual C(ethtool) device features and + offloads; every entry is a boolean toggle. Each key is + a feature name: run C(ethtool -k ) to list the + features a device supports and see C(man 8 ethtool) for + the meaning of each one. The individual features are + therefore not described separately below. Every feature + also accepts a deprecated alias that uses dashes + instead of underscores, matching the hyphen-separated + feature names that C(ethtool) and C(nmcli) use natively + (for example C(tx-tcp-segmentation) for + C(tx_tcp_segmentation)); use the underscored name + instead. + options: + esp_hw_offload: {type: bool} + esp-hw-offload: {type: bool} + esp_tx_csum_hw_offload: {type: bool} + esp-tx-csum-hw-offload: {type: bool} + fcoe_mtu: {type: bool} + fcoe-mtu: {type: bool} + gro: {type: bool} + gso: {type: bool} + highdma: {type: bool} + hw_tc_offload: {type: bool} + hw-tc-offload: {type: bool} + l2_fwd_offload: {type: bool} + l2-fwd-offload: {type: bool} + loopback: {type: bool} + lro: {type: bool} + ntuple: {type: bool} + rx: {type: bool} + rxhash: {type: bool} + rxvlan: {type: bool} + rx_all: {type: bool} + rx-all: {type: bool} + rx_fcs: {type: bool} + rx-fcs: {type: bool} + rx_gro_hw: {type: bool} + rx-gro-hw: {type: bool} + rx_udp_tunnel_port_offload: {type: bool} + rx-udp_tunnel-port-offload: {type: bool} + rx_vlan_filter: {type: bool} + rx-vlan-filter: {type: bool} + rx_vlan_stag_filter: {type: bool} + rx-vlan-stag-filter: {type: bool} + rx_vlan_stag_hw_parse: {type: bool} + rx-vlan-stag-hw-parse: {type: bool} + sg: {type: bool} + tls_hw_record: {type: bool} + tls-hw-record: {type: bool} + tls_hw_tx_offload: {type: bool} + tls-hw-tx-offload: {type: bool} + tso: {type: bool} + tx: {type: bool} + txvlan: {type: bool} + tx_checksum_fcoe_crc: {type: bool} + tx-checksum-fcoe-crc: {type: bool} + tx_checksum_ipv4: {type: bool} + tx-checksum-ipv4: {type: bool} + tx_checksum_ipv6: {type: bool} + tx-checksum-ipv6: {type: bool} + tx_checksum_ip_generic: {type: bool} + tx-checksum-ip-generic: {type: bool} + tx_checksum_sctp: {type: bool} + tx-checksum-sctp: {type: bool} + tx_esp_segmentation: {type: bool} + tx-esp-segmentation: {type: bool} + tx_fcoe_segmentation: {type: bool} + tx-fcoe-segmentation: {type: bool} + tx_gre_csum_segmentation: {type: bool} + tx-gre-csum-segmentation: {type: bool} + tx_gre_segmentation: {type: bool} + tx-gre-segmentation: {type: bool} + tx_gso_partial: {type: bool} + tx-gso-partial: {type: bool} + tx_gso_robust: {type: bool} + tx-gso-robust: {type: bool} + tx_ipxip4_segmentation: {type: bool} + tx-ipxip4-segmentation: {type: bool} + tx_ipxip6_segmentation: {type: bool} + tx-ipxip6-segmentation: {type: bool} + tx_nocache_copy: {type: bool} + tx-nocache-copy: {type: bool} + tx_scatter_gather: {type: bool} + tx-scatter-gather: {type: bool} + tx_scatter_gather_fraglist: {type: bool} + tx-scatter-gather-fraglist: {type: bool} + tx_sctp_segmentation: {type: bool} + tx-sctp-segmentation: {type: bool} + tx_tcp6_segmentation: {type: bool} + tx-tcp6-segmentation: {type: bool} + tx_tcp_ecn_segmentation: {type: bool} + tx-tcp-ecn-segmentation: {type: bool} + tx_tcp_mangleid_segmentation: {type: bool} + tx-tcp-mangleid-segmentation: {type: bool} + tx_tcp_segmentation: {type: bool} + tx-tcp-segmentation: {type: bool} + tx_udp_segmentation: {type: bool} + tx-udp-segmentation: {type: bool} + tx_udp_tnl_csum_segmentation: {type: bool} + tx-udp_tnl-csum-segmentation: {type: bool} + tx_udp_tnl_segmentation: {type: bool} + tx-udp_tnl-segmentation: {type: bool} + tx_vlan_stag_hw_insert: {type: bool} + tx-vlan-stag-hw-insert: {type: bool} + coalesce: + type: dict + description: > + A dictionary of C(ethtool) interrupt coalescing + settings. The C(*_low) and C(*_high) variants are only + used when adaptive coalescing is enabled, applying + while the measured packet rate is below C(pkt_rate_low) + or above C(pkt_rate_high) respectively. + options: + adaptive_rx: + type: bool + description: > + Whether adaptive Rx interrupt coalescing is + enabled, letting the driver tune the Rx coalescing + parameters dynamically based on the packet rate. + adaptive_tx: + type: bool + description: > + Whether adaptive Tx interrupt coalescing is + enabled, letting the driver tune the Tx coalescing + parameters dynamically based on the packet rate. + pkt_rate_high: + type: int + description: > + The packet rate, in packets per second, above + which the C(*_high) coalescing parameters are used. + pkt_rate_low: + type: int + description: > + The packet rate, in packets per second, below + which the C(*_low) coalescing parameters are used. + rx_frames: + type: int + description: > + The maximum number of received packets to wait for + before raising an Rx interrupt. + rx_frames_high: + type: int + description: > + The number of received packets to wait for before + raising an Rx interrupt while the packet rate is + above C(pkt_rate_high). + rx_frames_irq: + type: int + description: > + The maximum number of received packets to wait for + before raising an Rx interrupt while the host is + already servicing an interrupt. + rx_frames_low: + type: int + description: > + The number of received packets to wait for before + raising an Rx interrupt while the packet rate is + below C(pkt_rate_low). + rx_usecs: + type: int + description: > + The number of microseconds to wait after a packet + is received before raising an Rx interrupt. + rx_usecs_high: + type: int + description: > + The number of microseconds to wait before raising + an Rx interrupt while the packet rate is above + C(pkt_rate_high). + rx_usecs_irq: + type: int + description: > + The number of microseconds to wait before raising + an Rx interrupt while the host is already servicing + an interrupt. + rx_usecs_low: + type: int + description: > + The number of microseconds to wait before raising + an Rx interrupt while the packet rate is below + C(pkt_rate_low). + sample_interval: + type: int + description: > + How often, in seconds, the adaptive coalescing + logic samples the packet rate. + stats_block_usecs: + type: int + description: > + The number of microseconds to wait between updates + of the device's in-memory statistics. + tx_frames: + type: int + description: > + The maximum number of packets to transmit before + raising a Tx interrupt. + tx_frames_high: + type: int + description: > + The number of packets to transmit before raising a + Tx interrupt while the packet rate is above + C(pkt_rate_high). + tx_frames_irq: + type: int + description: > + The maximum number of packets to transmit before + raising a Tx interrupt while the host is already + servicing an interrupt. + tx_frames_low: + type: int + description: > + The number of packets to transmit before raising a + Tx interrupt while the packet rate is below + C(pkt_rate_low). + tx_usecs: + type: int + description: > + The number of microseconds to wait after a packet + is transmitted before raising a Tx interrupt. + tx_usecs_high: + type: int + description: > + The number of microseconds to wait before raising + a Tx interrupt while the packet rate is above + C(pkt_rate_high). + tx_usecs_irq: + type: int + description: > + The number of microseconds to wait before raising + a Tx interrupt while the host is already servicing + an interrupt. + tx_usecs_low: + type: int + description: > + The number of microseconds to wait before raising + a Tx interrupt while the packet rate is below + C(pkt_rate_low). + ring: + type: dict + description: > + A dictionary of C(ethtool) C(rx)/C(tx) ring buffer + entry counts. + options: + rx: + type: int + description: The number of ring entries for the Rx ring. + rx_jumbo: + type: int + description: > + The number of ring entries for the Rx Jumbo ring. + rx_mini: + type: int + description: The number of ring entries for the Rx Mini ring. + tx: + type: int + description: The number of ring entries for the Tx ring. + bond: + type: dict + description: > + The bonding options of a V(bond) profile. See the + L(kernel bonding + documentation,https://www.kernel.org/doc/Documentation/networking/bonding.txt) + or your distribution's C(nmcli) documentation for valid + values. + options: + mode: + type: str + choices: + - balance-rr + - active-backup + - balance-xor + - broadcast + - 802.3ad + - balance-tlb + - balance-alb + default: balance-rr + description: > + The bonding mode. + ad_actor_sys_prio: + type: int + description: > + The 802.3ad system priority. Only valid with mode + V(802.3ad). + ad_actor_system: + type: str + description: > + The 802.3ad system MAC address used for the actor in + LACPDU protocol packet exchanges. Only valid with + mode V(802.3ad). + ad_select: + type: str + choices: + - stable + - bandwidth + - count + description: > + The 802.3ad aggregation selection logic to use. Only + valid with mode V(802.3ad). + ad_user_port_key: + type: int + description: > + The upper 10 bits of the port key. Only valid with + mode V(802.3ad). + all_ports_active: + type: bool + description: > + Whether duplicate frames received on inactive ports + are delivered (V(true)) or dropped (V(false)). + arp_all_targets: + type: str + choices: + - any + - all + description: > + How many of C(arp_ip_target) addresses must be + reachable for the ARP monitor to consider a port up. + Only valid with modes V(balance-rr), V(active-backup), + V(balance-xor), or V(broadcast). + arp_interval: + type: int + description: > + The ARP link monitoring frequency in milliseconds. + V(0) disables ARP monitoring. Requires + C(arp_ip_target) to be set. Only valid with modes + V(balance-rr), V(active-backup), V(balance-xor), or + V(broadcast). + arp_validate: + type: str + choices: + - none + - active + - backup + - all + - filter + - filter_active + - filter_backup + description: > + Whether ARP probes and replies should be validated in + any mode that supports ARP monitoring, or whether + non-ARP traffic should be filtered for link + monitoring purposes. Only valid with modes + V(balance-rr), V(active-backup), V(balance-xor), or + V(broadcast). + arp_ip_target: + type: str + description: > + The IP addresses to use as ARP monitoring peers when + C(arp_interval) is enabled. Requires C(arp_interval) to + be set. + downdelay: + type: int + description: > + The time to wait, in milliseconds, before disabling a + port after a link failure is detected. Requires + C(miimon) to be enabled. + fail_over_mac: + type: str + choices: + - none + - active + - follow + description: > + The policy for selecting the MAC address of the bond + interface in V(active-backup) mode. + lacp_rate: + type: str + choices: + - slow + - fast + description: > + The rate at which link partners are asked to transmit + LACPDU packets. Only valid with mode V(802.3ad). + lp_interval: + type: int + description: > + The number of seconds between instances where the + bonding driver sends learning packets to each port's + peer switch. + miimon: + type: int + description: > + The MII link monitoring interval in milliseconds. + min_links: + type: int + description: > + The minimum number of active links required before + the carrier is asserted. + num_grat_arp: + type: int + description: > + The number of gratuitous ARP peer notifications to + issue after a failover event. + packets_per_port: + type: int + description: > + The number of packets to transmit through a port + before moving to the next one. Only valid with mode + V(balance-rr). + peer_notif_delay: + type: int + description: > + The delay, in milliseconds, between each peer + notification issued after a failover event. Requires + C(miimon) to be enabled and must be a multiple of + C(miimon). Not allowed together with C(arp_interval). + primary: + type: str + description: > + The name of the primary port device. Only valid with + modes V(active-backup), V(balance-tlb), or + V(balance-alb). + primary_reselect: + type: str + choices: + - always + - better + - failure + description: > + The reselection policy for the primary port. + resend_igmp: + type: int + description: > + The number of IGMP membership reports to issue after + a failover event. + tlb_dynamic_lb: + type: bool + description: > + Whether dynamic shuffling of flows is enabled. Only + valid with modes V(balance-tlb) or V(balance-alb). + updelay: + type: int + description: > + The time to wait, in milliseconds, before enabling a + port after a link recovery is detected. Requires + C(miimon) to be enabled. + use_carrier: + type: bool + description: > + Whether the C(netif_carrier_ok) function (V(true)) or + MII/ETHTOOL ioctls (V(false)) are used to determine + link status for C(miimon). + xmit_hash_policy: + type: str + choices: + - layer2 + - layer3+4 + - layer2+3 + - encap2+3 + - encap3+4 + - vlan+srcmac + description: > + The transmit hash policy used for port selection. + infiniband: + type: dict + description: > + Settings for V(infiniband) connections. Only supported by + the V(nm) provider. + options: + transport_mode: + type: str + choices: + - datagram + - connected + default: datagram + description: > + The IP over Infiniband (ipoib) operation mode. + p_key: + type: int + description: > + The Infiniband P_Key to use for the device, a 16-bit + unsigned integer with the high bit set for "full + membership". The values V(0x0000) and V(0x8000) are + invalid. If set, C(mac) or C(parent) must also be set, + and C(interface_name) must be unset. When unset, the + connection is created on the physical Infiniband + fabric. + vlan: + type: dict + description: > + Settings for V(vlan) connections. + options: + id: + type: int + required: true + description: > + The VLAN ID, ranging from 0 to 4094. + macvlan: + type: dict + description: > + Settings for V(macvlan) connections. + options: + mode: + type: str + choices: + - vepa + - bridge + - private + - passthru + - source + default: bridge + description: > + The MACVLAN mode. + promiscuous: + type: bool + default: true + description: > + Whether the underlying device is used in promiscuous + mode. Can only be disabled (V(false)) when C(mode) is + V(passthru). + tap: + type: bool + default: false + description: > + Whether the device should be a MACVTAP device instead + of a regular MACVLAN device. + ieee802_1x: + type: dict + description: > + 802.1x authentication settings for V(ethernet) or + V(wireless) interfaces. Only supported by the V(nm) + provider. V(tls) is currently the only supported EAP + method, and the certificates and keys it references must + already be deployed on the host before running the role. + options: + eap: + type: str + choices: + - tls + default: tls + description: > + The EAP method used to authenticate to the network. + identity: + type: str + required: true + description: > + The identity string for the EAP authentication + method. + private_key: + type: path + required: true + description: > + The absolute path to the client's PEM or PKCS#12 + encoded private key. + private_key_password: + type: str + description: > + The password protecting C(private_key). + private_key_password_flags: + type: list + elements: str + choices: + - none + - agent-owned + - not-saved + - not-required + description: > + Flags controlling how NetworkManager manages the + private key password. See the "Secret flag types" + section of C(man 5 nm-settings) for details. + client_cert: + type: path + required: true + description: > + The absolute path to the client's PEM encoded + certificate. + ca_cert: + type: path + description: > + The absolute path to the PEM encoded certificate + authority used to verify the EAP server. + ca_path: + type: path + description: > + The absolute path to a directory of additional PEM + encoded CA certificates used to verify the EAP + server. Can be used instead of or in addition to + C(ca_cert). Cannot be used together with + C(system_ca_certs). + system_ca_certs: + type: bool + default: false + description: > + Whether NetworkManager should use the system's + trusted CA certificates to verify the EAP server. + domain_suffix_match: + type: str + description: > + A domain name suffix that must match the domain name + in the EAP server's certificate. + wireless: + type: dict + description: > + Settings for V(wireless) connections, supporting WPA-PSK, + WPA-EAP (802.1x), WPA3-Personal SAE, and Enhanced Open + (OWE) authentication. Only supported by the V(nm) + provider. + options: + ssid: + type: str + required: true + description: > + The SSID of the wireless network. + key_mgmt: + type: str + required: true + choices: + - owe + - sae + - wpa-eap + - wpa-psk + description: > + The key management method used to authenticate to the + network. When V(wpa-eap) is used, 802.1x settings must + also be defined in C(ieee802_1x). + password: + type: str + description: > + The password for the network. Required when + C(key_mgmt) is V(wpa-psk) or V(sae), and not allowed + otherwise. + network_ignore_errors: + type: bool + description: > + Whether to ignore errors encountered while applying a + connection profile and continue applying the remaining + profiles instead of failing the play. Acts as the default for + every item of O(network_connections) that does not set its own + C(ignore_errors). + network_force_state_change: + type: bool + description: > + Whether to force the runtime state change requested by a + profile's C(state) even when the role does not detect a + difference between the requested and current configuration. + Acts as the default for every item of O(network_connections) + that does not set its own C(force_state_change). + network_state: + type: dict + default: {} + description: > + The desired network state to apply directly to the devices, + using the L(Nmstate,https://nmstate.io) schema (see the + L(Nmstate examples,https://nmstate.io/examples.html) and the + L(nmstate API + documentation,https://docs.rs/nmstate/latest/nmstate/index.html)). + When left empty, no state is applied. Only supported by the + V(nm) provider on RHEL 8 and later. Only the top-level keys + are listed below; nmstate itself validates everything nested + under them, so this role does not re-validate that content. + options: + description: + type: str + description: > + A human-readable description of the whole desired state. + Not persisted or applied by the network backend. + hostname: + type: dict + description: > + The desired hostname configuration. See the L(Nmstate + hostname schema,https://nmstate.io/devel/yaml_api.html) + for its exact structure. + dns-resolver: + type: dict + description: > + The desired DNS resolver configuration (search domains + and servers). See the L(Nmstate DNS resolver + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. Cannot be used while NetworkManager has + a C([global-dns]) or C([global-dns-domain-*]) section + configured. + routes: + type: dict + description: > + The desired static routes. See the L(Nmstate routes + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. + route-rules: + type: dict + description: > + The desired routing rules. See the L(Nmstate route rules + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. + interfaces: + type: list + elements: dict + description: > + The desired per-interface configuration (type, state, IP + addressing, and type-specific settings such as bridge, + bond, or VLAN options). See the L(Nmstate interface + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. + ovs-db: + type: dict + description: > + The desired global Open vSwitch database configuration. + See the L(Nmstate OVS-DB + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. + ovn: + type: dict + description: > + The desired OVN (Open Virtual Network) mapping + configuration. See the L(Nmstate OVN + schema,https://nmstate.io/devel/yaml_api.html) for its + exact structure. + network_allow_restart: + type: bool + default: false + description: > + Whether the role is allowed to restart NetworkManager when a + package installed for a wireless or team interface (such as + C(NetworkManager-wifi) or C(NetworkManager-team)) requires it + to be reloaded. A restart can disrupt connectivity, so the + role refuses to restart NetworkManager unless this is set to + V(true). + # examples renders as the "Examples" section. It is a single YAML block + # (note the "|") holding one or more example plays. Give each play a + # "name" so the reader can tell the examples apart. + examples: | + - name: Configure an Ethernet profile with full IPv4 and IPv6 settings + hosts: all + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + route_metric4: 100 + dhcp4: false + gateway4: 192.0.2.1 + dns: + - 192.0.2.2 + - 198.51.100.5 + dns_search: + - example.com + - subdomain.example.com + dns_options: + - rotate + - timeout:1 + route_metric6: -1 + auto6: false + gateway6: 2001:db8::1 + address: + - 192.0.2.3/24 + - 198.51.100.3/26 + - 2001:db8::80/7 + route: + - network: 198.51.100.128 + prefix: 26 + gateway: 198.51.100.1 + metric: 2 + - network: 198.51.100.64 + prefix: 26 + gateway: 198.51.100.6 + metric: 4 + route_append_only: false + rule_append_only: true + roles: + - linux-system-roles.network + + - name: Create a bridge with a bond attached to it + hosts: all + vars: + network_connections: + - name: internal-br0 + interface_name: br0 + type: bridge + ip: + dhcp4: false + auto6: false + - name: br0-bond0 + type: bond + interface_name: bond0 + controller: internal-br0 + port_type: bridge + - name: br0-bond0-eth1 + type: ethernet + interface_name: eth1 + controller: br0-bond0 + port_type: bond + roles: + - linux-system-roles.network + + - name: Configure a VLAN on top of an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth1-profile + autoconnect: false + type: ethernet + interface_name: eth1 + ip: + dhcp4: false + auto6: false + - name: eth1.6 + autoconnect: false + type: vlan + parent: eth1-profile + vlan: + id: 6 + ip: + address: + - 192.0.2.5/24 + auto6: false + roles: + - linux-system-roles.network + + - name: Configure a MACVLAN on top of an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth0-profile + type: ethernet + interface_name: eth0 + ip: + address: + - 192.168.0.1/24 + - name: veth0 + type: macvlan + parent: eth0-profile + macvlan: + mode: bridge + promiscuous: true + tap: false + ip: + address: + - 192.168.1.1/24 + roles: + - linux-system-roles.network + + - name: Configure a WPA-PSK wireless connection + hosts: all + vars: + network_connections: + - name: wlan0 + type: wireless + wireless: + ssid: "My WPA2-PSK Network" + key_mgmt: "wpa-psk" + # recommend vault encrypting the wireless password + password: "{{ vault_wifi_password }}" + roles: + - linux-system-roles.network + + - name: Configure 802.1x (EAP-TLS) authentication on an Ethernet profile + hosts: all + vars: + network_connections: + - name: eth0 + type: ethernet + ieee802_1x: + identity: myhost + eap: tls + private_key: /etc/pki/tls/client.key + # recommend vault encrypting the private key password + private_key_password: "{{ vault_private_key_password }}" + client_cert: /etc/pki/tls/client.pem + ca_cert: /etc/pki/tls/cacert.pem + domain_suffix_match: example.com + roles: + - linux-system-roles.network + + - name: Apply IP addresses directly to devices with network_state + hosts: all + vars: + network_state: + interfaces: + - name: ethtest0 + type: ethernet + state: up + ipv4: + enabled: true + address: + - ip: 192.168.122.250 + prefix-length: 24 + dhcp: false + ipv6: + enabled: true + address: + - ip: 2001:db8::1:1 + prefix-length: 64 + autoconf: false + dhcp: false + roles: + - linux-system-roles.network + + - name: Configure a static route with network_state + hosts: all + vars: + network_state: + interfaces: + - name: eth1 + type: ethernet + state: up + ipv4: + enabled: true + address: + - ip: 192.0.2.251 + prefix-length: 24 + dhcp: false + routes: + config: + - destination: 198.51.100.0/24 + metric: 150 + next-hop-address: 192.0.2.251 + next-hop-interface: eth1 + table-id: 254 + roles: + - linux-system-roles.network + + - name: Configure DNS search domains and servers with network_state + hosts: all + vars: + network_state: + dns-resolver: + config: + search: + - example.com + - example.org + server: + - 2001:4860:4860::8888 + - 8.8.8.8 + roles: + - linux-system-roles.network diff --git a/sphinx_html/.buildinfo b/sphinx_html/.buildinfo new file mode 100644 index 000000000..058bcd2f3 --- /dev/null +++ b/sphinx_html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: a9689d5a41b099ded0c39af08cd29dbc +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/sphinx_html/_static/_sphinx_javascript_frameworks_compat.js b/sphinx_html/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 000000000..81415803e --- /dev/null +++ b/sphinx_html/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/sphinx_html/_static/antsibull-minimal.css b/sphinx_html/_static/antsibull-minimal.css new file mode 100644 index 000000000..5d0aa0767 --- /dev/null +++ b/sphinx_html/_static/antsibull-minimal.css @@ -0,0 +1,4 @@ +@charset "UTF-8"; +/* Copyright (c) Ansible and contributors */ +/* GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) */ +:root{--antsibull-links-background: #5bbdbf;--antsibull-links-background-active: #91d9db;--antsibull-links-focus-outline: #204748;--antsibull-links-text: #fff;--antsibull-table-background-header: #6ab0de;--antsibull-table-background-even: #e7f2fa;--antsibull-table-background-odd: #fff;--antsibull-table-border: #000;--antsibull-narrowtable-background: #e7f2fa;--antsibull-option-type: purple;--antsibull-option-elements: purple;--antsibull-option-required: red;--antsibull-option-version-added: #006400;--antsibull-option-aliases: #006400;--antsibull-option-default: blue;--antsibull-option-sample: blue;--antsibull-option-sample-header: #000;--antsibull-attribute-support-none: red;--antsibull-attribute-support-partial: #a5a500;--antsibull-attribute-support-full: green;--antsibull-attribute-support-na: inherit;--antsibull-deprecation-border: #000;--antsibull-deprecation-background: #eee;--antsibull-deprecation-color: #000}.ansible-links{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-align:center;-webkit-align-items:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}.ansible-links>*{margin:2px 4px!important}.ansible-links>li{list-style:none!important}.ansible-links>li>p{display:inline}.ansible-links a{display:block;padding:4px 12px;cursor:pointer;border-radius:3px;background-color:var(--antsibull-links-background);color:var(--antsibull-links-text)}.ansible-links a:active,.ansible-links a:focus,.ansible-links a:hover{background-color:var(--antsibull-links-background-active)}.ansible-links a:focus{outline:3px solid var(--antsibull-links-focus-outline)}table.documentation-table{border-bottom:1px solid var(--antsibull-table-border);border-right:1px solid var(--antsibull-table-border)}table.documentation-table th{background-color:var(--antsibull-table-background-header)}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid var(--antsibull-table-border);border-top:1px solid var(--antsibull-table-border)}table.documentation-table td.elbow-placeholder{border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table tr .ansibleOptionLink{display:inline-block}table.documentation-table tr .ansibleOptionLink:after{content:"🔗";opacity:0}table.documentation-table tr:hover .ansibleOptionLink:after{opacity:1}table.documentation-table tr:nth-child(odd){background-color:var(--antsibull-table-background-odd)}table.documentation-table tr:nth-child(2n){background-color:var(--antsibull-table-background-even)}table.ansible-option-table{display:table;border-color:var(--antsibull-table-border)!important;height:1px}table.ansible-option-table tr{height:100%}table.ansible-option-table td,table.ansible-option-table th{border-color:var(--antsibull-table-border)!important;border-bottom:none!important;vertical-align:top!important}table.ansible-option-table th>p{font-size:medium!important}table.ansible-option-table thead tr{background-color:var(--antsibull-table-background-header)}table.ansible-option-table tbody .row-odd td{background-color:var(--antsibull-table-background-odd)!important}table.ansible-option-table tbody .row-even td{background-color:var(--antsibull-table-background-even)!important}table.ansible-option-table ul>li>p{margin:0!important}table.ansible-option-table ul>li>div[class^=highlight]{margin-bottom:4px!important}table.ansible-option-table p.ansible-option-title{display:inline}table.ansible-option-table .ansible-option-type-line{font-size:small;margin-bottom:0}table.ansible-option-table .ansible-option-type{color:var(--antsibull-option-type)}table.ansible-option-table .ansible-option-elements{color:var(--antsibull-option-elements)}table.ansible-option-table .ansible-option-required{color:var(--antsibull-option-required)}table.ansible-option-table .ansible-option-versionadded{font-size:small;color:var(--antsibull-option-version-added)}table.ansible-option-table .ansible-option-aliases{color:var(--antsibull-option-aliases);white-space:normal}table.ansible-option-table .ansible-option-line{margin-top:8px}table.ansible-option-table .ansible-option-choices-default-mark,table.ansible-option-table .ansible-option-default,table.ansible-option-table .ansible-option-default-bold{color:var(--antsibull-option-default)}table.ansible-option-table .ansible-option-sample{color:var(--antsibull-option-sample);word-wrap:break-word;word-break:break-all}table.ansible-option-table .ansible-option-sample-bold{color:var(--antsibull-option-sample-header)}table.ansible-option-table .ansible-attribute-support-none{color:var(--antsibull-attribute-support-none)}table.ansible-option-table .ansible-attribute-support-partial{color:var(--antsibull-attribute-support-partial)}table.ansible-option-table .ansible-attribute-support-full{color:var(--antsibull-attribute-support-full)}table.ansible-option-table .ansible-attribute-support-na{color:var(--antsibull-attribute-support-na)}table.ansible-option-table .ansibleOptionLink{display:inline-block}table.ansible-option-table .ansibleOptionLink:after{content:"🔗";opacity:0}table.ansible-option-table p{margin:0 0 8px}table.ansible-option-table tr:hover .ansibleOptionLink:after{opacity:1}table.ansible-option-table td{padding:0!important;white-space:normal}table.ansible-option-table td>div.ansible-option-cell{padding:8px 16px;border-top:1px solid var(--antsibull-table-border)}table.ansible-option-table td:first-child{height:inherit;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:first-child>div.ansible-option-cell{height:inherit;-webkit-box-flex:1;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;white-space:nowrap;max-width:100%}table.ansible-option-table .ansible-option-indent{margin-left:2em;border-right:1px solid var(--antsibull-table-border)}table.ansible-option-table .ansible-attribute-support-label{display:none}@media (max-width:1200px){table.ansible-option-table{display:block;height:unset;border:none!important}table.ansible-option-table thead{display:none}table.ansible-option-table tbody,table.ansible-option-table td,table.ansible-option-table tr{display:block;border:none!important}table.ansible-option-table tbody .row-even td,table.ansible-option-table tbody .row-odd td{background-color:unset!important}table.ansible-option-table td>div.ansible-option-cell{border-top:none}table.ansible-option-table td:first-child>div.ansible-option-cell{background-color:var(--antsibull-narrowtable-background)!important}table.ansible-option-table td:not(:first-child){display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:not(:first-child)>div.ansible-option-cell{margin-left:1em}table.ansible-option-table .ansible-option-indent,table.ansible-option-table .ansible-option-indent-desc{margin-left:1em;border:none;border-right:solid 3px var(--antsibull-narrowtable-background)}table.ansible-option-table .ansible-attribute-support-label{display:unset}}.ansible-version-added{font-style:italic}.ansible-option a.reference.external,.ansible-option a.reference.external:hover,.ansible-option a.reference.internal,.ansible-option a.reference.internal:hover,.ansible-option-value a.reference.external,.ansible-option-value a.reference.external:hover,.ansible-option-value a.reference.internal,.ansible-option-value a.reference.internal:hover,.ansible-return-value a.reference.external,.ansible-return-value a.reference.external:hover,.ansible-return-value a.reference.internal,.ansible-return-value a.reference.internal:hover{color:unset}.ansible-deprecation-marker{border-radius:1em;border:2px solid var(--antsibull-deprecation-border);background-color:var(--antsibull-deprecation-background);color:var(--antsibull-deprecation-color);padding:.2em .4em} \ No newline at end of file diff --git a/sphinx_html/_static/base-stemmer.js b/sphinx_html/_static/base-stemmer.js new file mode 100644 index 000000000..e6fa0c492 --- /dev/null +++ b/sphinx_html/_static/base-stemmer.js @@ -0,0 +1,476 @@ +// @ts-check + +/**@constructor*/ +BaseStemmer = function() { + /** @protected */ + this.current = ''; + this.cursor = 0; + this.limit = 0; + this.limit_backward = 0; + this.bra = 0; + this.ket = 0; + + /** + * @param {string} value + */ + this.setCurrent = function(value) { + this.current = value; + this.cursor = 0; + this.limit = this.current.length; + this.limit_backward = 0; + this.bra = this.cursor; + this.ket = this.limit; + }; + + /** + * @return {string} + */ + this.getCurrent = function() { + return this.current; + }; + + /** + * @param {BaseStemmer} other + */ + this.copy_from = function(other) { + /** @protected */ + this.current = other.current; + this.cursor = other.cursor; + this.limit = other.limit; + this.limit_backward = other.limit_backward; + this.bra = other.bra; + this.ket = other.ket; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor++; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) + return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) + return true; + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor--; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return true; + this.cursor--; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) { + this.cursor++; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) == 0) { + this.cursor++; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) { + this.cursor--; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) { + this.cursor--; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor--; + } + return false; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s = function(s) + { + /** @protected */ + if (this.limit - this.cursor < s.length) return false; + if (this.current.slice(this.cursor, this.cursor + s.length) != s) + { + return false; + } + this.cursor += s.length; + return true; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s_b = function(s) + { + /** @protected */ + if (this.cursor - this.limit_backward < s.length) return false; + if (this.current.slice(this.cursor - s.length, this.cursor) != s) + { + return false; + } + this.cursor -= s.length; + return true; + }; + + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among = function(v) + { + /** @protected */ + var i = 0; + var j = v.length; + + var c = this.cursor; + var l = this.limit; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >>> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; // smaller + // w[0]: string, w[1]: substring_i, w[2]: result, w[3]: function (optional) + var w = v[k]; + var i2; + for (i2 = common; i2 < w[0].length; i2++) + { + if (c + common == l) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c + common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; // v->s has been inspected + if (j == i) break; // only one item in v + + // - but now we need to go round once more to get + // v->s inspected. This looks messy, but is actually + // the optimal approach. + + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c + w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c + w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + // find_among_b is for backwards processing. Same comments apply + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among_b = function(v) + { + /** @protected */ + var i = 0; + var j = v.length + + var c = this.cursor; + var lb = this.limit_backward; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; + var w = v[k]; + var i2; + for (i2 = w[0].length - 1 - common; i2 >= 0; i2--) + { + if (c - common == lb) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c - 1 - common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; + if (j == i) break; + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c - w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c - w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + /* to replace chars between c_bra and c_ket in this.current by the + * chars in s. + */ + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + * @return {number} + */ + this.replace_s = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = s.length - (c_ket - c_bra); + this.current = this.current.slice(0, c_bra) + s + this.current.slice(c_ket); + this.limit += adjustment; + if (this.cursor >= c_ket) this.cursor += adjustment; + else if (this.cursor > c_bra) this.cursor = c_bra; + return adjustment; + }; + + /** + * @return {boolean} + */ + this.slice_check = function() + { + /** @protected */ + if (this.bra < 0 || + this.bra > this.ket || + this.ket > this.limit || + this.limit > this.current.length) + { + return false; + } + return true; + }; + + /** + * @param {number} c_bra + * @return {boolean} + */ + this.slice_from = function(s) + { + /** @protected */ + var result = false; + if (this.slice_check()) + { + this.replace_s(this.bra, this.ket, s); + result = true; + } + return result; + }; + + /** + * @return {boolean} + */ + this.slice_del = function() + { + /** @protected */ + return this.slice_from(""); + }; + + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + */ + this.insert = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = this.replace_s(c_bra, c_ket, s); + if (c_bra <= this.bra) this.bra += adjustment; + if (c_bra <= this.ket) this.ket += adjustment; + }; + + /** + * @return {string} + */ + this.slice_to = function() + { + /** @protected */ + var result = ''; + if (this.slice_check()) + { + result = this.current.slice(this.bra, this.ket); + } + return result; + }; + + /** + * @return {string} + */ + this.assign_to = function() + { + /** @protected */ + return this.current.slice(0, this.limit); + }; +}; diff --git a/sphinx_html/_static/basic.css b/sphinx_html/_static/basic.css new file mode 100644 index 000000000..4738b2edc --- /dev/null +++ b/sphinx_html/_static/basic.css @@ -0,0 +1,906 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/sphinx_html/_static/css/ansible.css b/sphinx_html/_static/css/ansible.css new file mode 100644 index 000000000..7eb125b5e --- /dev/null +++ b/sphinx_html/_static/css/ansible.css @@ -0,0 +1,495 @@ +@import 'theme.css'; +/*! minified with http://css-minify.online-domain-tools.com/ - all comments + * must have ! to preserve during minifying with that tool */ +/*! Fix for read the docs theme: + * https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html + */ +/*! override table width restrictions */ +@media screen and (min-width: 767px) { + /*! If we ever publish to read the docs, we need to use !important for + * these two styles as read the docs itself loads their theme in a way that + * we can't otherwise override it. + */ + .wy-table-responsive table td { + white-space: normal; + } + .wy-table-responsive { + overflow: visible; + } +} +/*! + * We use the class documentation-table for attribute tables where the first + * column is the name of an attribute and the second column is the description. + */ +/*! These tables look like this: + * + * Attribute Name Description + * -------------- ----------- + * **NAME** This is a multi-line description + * str/required that can span multiple lines + * added in x.y + * With multiple paragraphs + * -------------- ----------- + * + * **NAME** is given the class .value-name + * str is given the class .value-type + * / is given the class .value-separator + * required is given the class .value-required + * added in x.y is given the class .value-added-in + */ +/*! The extra .rst-content is so this will override rtd theme */ +.rst-content table.documentation-table td { + vertical-align: top; +} +table.documentation-table td:first-child { + white-space: nowrap; + vertical-align: top; +} +table.documentation-table td:first-child p:first-child { + font-weight: 700; + display: inline; +} +/*! This is now redundant with above position-based styling */ +/*! +table.documentation-table .value-name { + font-weight: bold; + display: inline; +} +*/ +table.documentation-table .value-type { + font-size: x-small; + color: purple; + display: inline; +} +table.documentation-table .value-separator { + font-size: x-small; + display: inline; +} +table.documentation-table .value-required { + font-size: x-small; + color: red; + display: inline; +} +.value-added-in { + font-size: x-small; + font-style: italic; + color: green; + display: inline; +} +/*! Ansible-specific CSS pulled out of rtd theme for 2.9 */ +.DocSiteProduct-header { + flex: 1; + -webkit-flex: 1; + padding: 10px 20px 20px; + display: flex; + display: -webkit-flex; + flex-direction: column; + -webkit-flex-direction: column; + align-items: center; + -webkit-align-items: center; + justify-content: flex-start; + -webkit-justify-content: flex-start; + margin-left: 20px; + margin-right: 20px; + text-decoration: none; + font-weight: 400; + font-family: "Open Sans", sans-serif; +} +.DocSiteProduct-header:active, +.DocSiteProduct-header:focus, +.DocSiteProduct-header:visited { + color: #fff; +} +.DocSiteProduct-header--core { + font-size: 25px; + background-color: #5bbdbf; + border: 2px solid #5bbdbf; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + color: #fff; + padding-left: 2px; + margin-left: 2px; +} +.DocSiteProduct-headerAlign { + width: 100%; +} +.DocSiteProduct-logo { + width: 60px; + height: 60px; + margin-bottom: -9px; +} +.DocSiteProduct-logoText { + margin-top: 6px; + font-size: 25px; + text-align: left; +} +.DocSiteProduct-CheckVersionPara { + margin-left: 2px; + padding-bottom: 4px; + margin-right: 2px; + margin-bottom: 10px; +} +/*! Ansible color scheme */ +.wy-nav-top, +.wy-side-nav-search { + background-color: #5bbdbf; +} +.wy-menu-vertical header, +.wy-menu-vertical p.caption { + color: #5bbdbf; +} +.wy-menu-vertical a { + padding: 0; +} +.wy-menu-vertical a.reference.internal { + padding: 0.4045em 1.618em; +} +/* Fix truncation when extranav is hidden */ +.wy-menu-vertical:not(:has(.sideBanner)) { + padding-bottom: 2rem; +} +/*! Override sphinx rtd theme max-with of 800px */ +.wy-nav-content { + max-width: 100%; +} +/*! + * Override sphinx_rtd_theme - keeps left-nav from overwriting + * Documentation title + **/ +.wy-nav-side { + top: 45px; +} +/*! + * Ansible - changed absolute to relative to remove extraneous side scroll bar + **/ +.wy-grid-for-nav { + position: relative; +} +/*! Ansible narrow the search box */ +.wy-side-nav-search input[type="text"] { + width: 90%; + padding-left: 24px; +} +/*! Ansible - remove so highlight indenting is correct */ +.rst-content .highlighted { + padding: 0; +} +.DocSiteBanner { + display: flex; + display: -webkit-flex; + justify-content: center; + -webkit-justify-content: center; + flex-wrap: wrap; + -webkit-flex-wrap: wrap; + margin-bottom: 25px; +} +.DocSiteBanner-imgWrapper { + max-width: 100%; +} +td, +th { + min-width: 100px; +} +table { + overflow-x: auto; + max-width: 100%; +} +.documentation-table td, +.documentation-table th { + padding: 4px; + border-left: 1px solid #000; + border-top: 1px solid #000; +} +.documentation-table { + border-right: 1px solid #000; + border-bottom: 1px solid #000; +} +@media print { + * { + background: 0 0 !important; + color: #000 !important; + text-shadow: none !important; + filter: none !important; + -ms-filter: none !important; + } + #nav, + a, + a:visited { + text-decoration: underline; + } + a[href]:after { + content: " (" attr(href) ")"; + } + abbr[title]:after { + content: " (" attr(title) ")"; + } + .ir a:after, + a[href^="javascript:"]:after, + a[href^="#"]:after { + content: ""; + } + /*! Don't show links for images, or javascript/internal links */ + pre, + blockquote { + border: 0 solid #999; + page-break-inside: avoid; + } + thead { + display: table-header-group; + } + /*! h5bp.com/t */ + tr, + img { + page-break-inside: avoid; + } + img { + max-width: 100% !important; + } + @page { + margin: 0.5cm; + } + h2, + h3, + p { + orphans: 3; + widows: 3; + } + h2, + h3 { + page-break-after: avoid; + } + #google_image_div, + .DocSiteBanner { + display: none !important; + } +} +#sideBanner, +.DocSite-globalNav { + display: none; +} +.DocSite-sideNav { + display: block; + margin-bottom: 40px; +} +.DocSite-nav { + display: none; +} +.ansibleNav { + background: #000; + padding: 0 20px; + width: auto; + border-bottom: 1px solid #444; + font-size: 14px; + z-index: 1; +} +.ansibleNav ul { + list-style: none; + padding-left: 0; + margin-top: 0; +} +.ansibleNav ul li { + padding: 7px 0; + border-bottom: 1px solid #444; +} +.ansibleNav ul li:last-child { + border: none; +} +.ansibleNav ul li a { + color: #fff; + text-decoration: none; + text-transform: uppercase; + padding: 6px 0; +} +.ansibleNav ul li a:hover { + color: #5bbdbf; + background: 0 0; +} +h4 { + font-size: 105%; +} +h5 { + font-size: 90%; +} +h6 { + font-size: 80%; +} +@media screen and (min-width: 768px) { + .DocSite-globalNav { + display: block; + position: fixed; + } + #sideBanner { + display: block; + } + .DocSite-sideNav { + display: none; + } + .DocSite-nav { + flex: initial; + -webkit-flex: initial; + display: flex; + display: -webkit-flex; + flex-direction: row; + -webkit-flex-direction: row; + justify-content: flex-start; + -webkit-justify-content: flex-start; + padding: 15px; + background-color: #000; + text-decoration: none; + font-family: "Open Sans", sans-serif; + } + .DocSiteNav-logo { + width: 28px; + height: 28px; + margin-right: 8px; + margin-top: -6px; + position: fixed; + z-index: 1; + } + .DocSiteNav-title { + color: #fff; + font-size: 20px; + position: fixed; + margin-left: 40px; + margin-top: -4px; + z-index: 1; + } + .ansibleNav { + height: 45px; + width: 100%; + font-size: 13px; + padding: 0 60px 0 0; + } + .ansibleNav ul { + float: right; + display: flex; + flex-wrap: nowrap; + margin-top: 13px; + } + .ansibleNav ul li { + padding: 0; + border-bottom: none; + } + .ansibleNav ul li a { + color: #fff; + text-decoration: none; + text-transform: uppercase; + padding: 8px 13px; + } + h4 { + font-size: 105%; + } + h5 { + font-size: 90%; + } + h6 { + font-size: 80%; + } +} +@media screen and (min-width: 768px) { + #sideBanner, + .DocSite-globalNav { + display: block; + } + .DocSite-sideNav { + display: none; + } + .DocSite-nav { + flex: initial; + -webkit-flex: initial; + display: flex; + display: -webkit-flex; + flex-direction: row; + -webkit-flex-direction: row; + justify-content: flex-start; + -webkit-justify-content: flex-start; + padding: 15px; + background-color: #000; + text-decoration: none; + font-family: "Open Sans", sans-serif; + } + .DocSiteNav-logo { + width: 28px; + height: 28px; + margin-right: 8px; + margin-top: -6px; + position: fixed; + } + .DocSiteNav-title { + color: #fff; + font-size: 20px; + position: fixed; + margin-left: 40px; + margin-top: -4px; + } + .ansibleNav { + height: 45px; + font-size: 13px; + padding: 0 60px 0 0; + } + .ansibleNav ul { + float: right; + display: flex; + flex-wrap: nowrap; + margin-top: 13px; + } + .ansibleNav ul li { + padding: 0; + border-bottom: none; + } + .ansibleNav ul li a { + color: #fff; + text-decoration: none; + text-transform: uppercase; + padding: 8px 13px; + } + h4 { + font-size: 105%; + } + h5 { + font-size: 90%; + } + h6 { + font-size: 80%; + } +} +/* ansibleOptionLink is adapted from h1 .headerlink in sphinx_rtd_theme */ +/* This definition lives in the antsibull Sphinx extension; we update it here to use the icon from FontAwesome */ +/* https://github.com/ansible-community/antsibull-docs/blob/main/src/sphinx_antsibull_ext/css/antsibull-minimal.scss */ +tr .ansibleOptionLink::after { + content: "" !important; + font-family: FontAwesome; +} +tr .ansibleOptionLink { + font: normal normal normal 14px/1 FontAwesome; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +@media screen and (min-width: 767px) { + /* Move anchors a bit up so that they aren't hidden by the header bar */ + section [id] { + padding-top: 45px; + margin-top: -45px; + } + /* + * Without this, + * for example most links in the page's TOC aren't usable anymore, and tables + * sometimes overlap the text above + * */ + section a[id], section table[id] { + padding-top: 0; + margin-top: 0; + } +} + +/* Assure reading examples does not require horizontal scrolling */ +.rst-content div[class^="highlight"] pre { + white-space: pre-wrap; +} + +.rst-content dl dt { margin-bottom: 0; } + +/*! Make sure that environment variable links are blue */ +.rst-content code.xref.std-envvar { color: #2980b9; } diff --git a/sphinx_html/_static/css/badge_only.css b/sphinx_html/_static/css/badge_only.css new file mode 100644 index 000000000..88ba55b96 --- /dev/null +++ b/sphinx_html/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/sphinx_html/_static/css/fonts/fontawesome-webfont.woff2 b/sphinx_html/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 000000000..4d13fc604 Binary files /dev/null and b/sphinx_html/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/sphinx_html/_static/css/rtd-ethical-ads.css b/sphinx_html/_static/css/rtd-ethical-ads.css new file mode 100644 index 000000000..a146003e6 --- /dev/null +++ b/sphinx_html/_static/css/rtd-ethical-ads.css @@ -0,0 +1,4 @@ +.ethical-sidebar, +.ethical-footer { + border-radius: 0 !important; +} diff --git a/sphinx_html/_static/css/theme.css b/sphinx_html/_static/css/theme.css new file mode 100644 index 000000000..a88467c1b --- /dev/null +++ b/sphinx_html/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%;float:none;margin-left:0}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/sphinx_html/_static/doctools.js b/sphinx_html/_static/doctools.js new file mode 100644 index 000000000..807cdb176 --- /dev/null +++ b/sphinx_html/_static/doctools.js @@ -0,0 +1,150 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})`, + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)), + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS + && !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) + return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/sphinx_html/_static/documentation_options.js b/sphinx_html/_static/documentation_options.js new file mode 100644 index 000000000..1823c1bde --- /dev/null +++ b/sphinx_html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: false, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/sphinx_html/_static/english-stemmer.js b/sphinx_html/_static/english-stemmer.js new file mode 100644 index 000000000..056760ee8 --- /dev/null +++ b/sphinx_html/_static/english-stemmer.js @@ -0,0 +1,1066 @@ +// Generated from english.sbl by Snowball 3.0.1 - https://snowballstem.org/ + +/**@constructor*/ +var EnglishStemmer = function() { + var base = new BaseStemmer(); + + /** @const */ var a_0 = [ + ["arsen", -1, -1], + ["commun", -1, -1], + ["emerg", -1, -1], + ["gener", -1, -1], + ["later", -1, -1], + ["organ", -1, -1], + ["past", -1, -1], + ["univers", -1, -1] + ]; + + /** @const */ var a_1 = [ + ["'", -1, 1], + ["'s'", 0, 1], + ["'s", -1, 1] + ]; + + /** @const */ var a_2 = [ + ["ied", -1, 2], + ["s", -1, 3], + ["ies", 1, 2], + ["sses", 1, 1], + ["ss", 1, -1], + ["us", 1, -1] + ]; + + /** @const */ var a_3 = [ + ["succ", -1, 1], + ["proc", -1, 1], + ["exc", -1, 1] + ]; + + /** @const */ var a_4 = [ + ["even", -1, 2], + ["cann", -1, 2], + ["inn", -1, 2], + ["earr", -1, 2], + ["herr", -1, 2], + ["out", -1, 2], + ["y", -1, 1] + ]; + + /** @const */ var a_5 = [ + ["", -1, -1], + ["ed", 0, 2], + ["eed", 1, 1], + ["ing", 0, 3], + ["edly", 0, 2], + ["eedly", 4, 1], + ["ingly", 0, 2] + ]; + + /** @const */ var a_6 = [ + ["", -1, 3], + ["bb", 0, 2], + ["dd", 0, 2], + ["ff", 0, 2], + ["gg", 0, 2], + ["bl", 0, 1], + ["mm", 0, 2], + ["nn", 0, 2], + ["pp", 0, 2], + ["rr", 0, 2], + ["at", 0, 1], + ["tt", 0, 2], + ["iz", 0, 1] + ]; + + /** @const */ var a_7 = [ + ["anci", -1, 3], + ["enci", -1, 2], + ["ogi", -1, 14], + ["li", -1, 16], + ["bli", 3, 12], + ["abli", 4, 4], + ["alli", 3, 8], + ["fulli", 3, 9], + ["lessli", 3, 15], + ["ousli", 3, 10], + ["entli", 3, 5], + ["aliti", -1, 8], + ["biliti", -1, 12], + ["iviti", -1, 11], + ["tional", -1, 1], + ["ational", 14, 7], + ["alism", -1, 8], + ["ation", -1, 7], + ["ization", 17, 6], + ["izer", -1, 6], + ["ator", -1, 7], + ["iveness", -1, 11], + ["fulness", -1, 9], + ["ousness", -1, 10], + ["ogist", -1, 13] + ]; + + /** @const */ var a_8 = [ + ["icate", -1, 4], + ["ative", -1, 6], + ["alize", -1, 3], + ["iciti", -1, 4], + ["ical", -1, 4], + ["tional", -1, 1], + ["ational", 5, 2], + ["ful", -1, 5], + ["ness", -1, 5] + ]; + + /** @const */ var a_9 = [ + ["ic", -1, 1], + ["ance", -1, 1], + ["ence", -1, 1], + ["able", -1, 1], + ["ible", -1, 1], + ["ate", -1, 1], + ["ive", -1, 1], + ["ize", -1, 1], + ["iti", -1, 1], + ["al", -1, 1], + ["ism", -1, 1], + ["ion", -1, 2], + ["er", -1, 1], + ["ous", -1, 1], + ["ant", -1, 1], + ["ent", -1, 1], + ["ment", 15, 1], + ["ement", 16, 1] + ]; + + /** @const */ var a_10 = [ + ["e", -1, 1], + ["l", -1, 2] + ]; + + /** @const */ var a_11 = [ + ["andes", -1, -1], + ["atlas", -1, -1], + ["bias", -1, -1], + ["cosmos", -1, -1], + ["early", -1, 5], + ["gently", -1, 3], + ["howe", -1, -1], + ["idly", -1, 2], + ["news", -1, -1], + ["only", -1, 6], + ["singly", -1, 7], + ["skies", -1, 1], + ["sky", -1, -1], + ["ugly", -1, 4] + ]; + + /** @const */ var /** Array */ g_aeo = [17, 64]; + + /** @const */ var /** Array */ g_v = [17, 65, 16, 1]; + + /** @const */ var /** Array */ g_v_WXY = [1, 17, 65, 208, 1]; + + /** @const */ var /** Array */ g_valid_LI = [55, 141, 2]; + + var /** boolean */ B_Y_found = false; + var /** number */ I_p2 = 0; + var /** number */ I_p1 = 0; + + + /** @return {boolean} */ + function r_prelude() { + B_Y_found = false; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + base.bra = base.cursor; + if (!(base.eq_s("'"))) + { + break lab0; + } + base.ket = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.cursor = v_1; + /** @const */ var /** number */ v_2 = base.cursor; + lab1: { + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab1; + } + base.ket = base.cursor; + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + } + base.cursor = v_2; + /** @const */ var /** number */ v_3 = base.cursor; + lab2: { + while(true) + { + /** @const */ var /** number */ v_4 = base.cursor; + lab3: { + golab4: while(true) + { + /** @const */ var /** number */ v_5 = base.cursor; + lab5: { + if (!(base.in_grouping(g_v, 97, 121))) + { + break lab5; + } + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab5; + } + base.ket = base.cursor; + base.cursor = v_5; + break golab4; + } + base.cursor = v_5; + if (base.cursor >= base.limit) + { + break lab3; + } + base.cursor++; + } + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + continue; + } + base.cursor = v_4; + break; + } + } + base.cursor = v_3; + return true; + }; + + /** @return {boolean} */ + function r_mark_regions() { + I_p1 = base.limit; + I_p2 = base.limit; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + lab1: { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + if (base.find_among(a_0) == 0) + { + break lab2; + } + break lab1; + } + base.cursor = v_2; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + } + I_p1 = base.cursor; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + I_p2 = base.cursor; + } + base.cursor = v_1; + return true; + }; + + /** @return {boolean} */ + function r_shortv() { + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.out_grouping_b(g_v_WXY, 89, 121))) + { + break lab1; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + lab2: { + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (base.cursor > base.limit_backward) + { + break lab2; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("past"))) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_R1() { + return I_p1 <= base.cursor; + }; + + /** @return {boolean} */ + function r_R2() { + return I_p2 <= base.cursor; + }; + + /** @return {boolean} */ + function r_Step_1a() { + var /** number */ among_var; + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab0: { + base.ket = base.cursor; + if (base.find_among_b(a_1) == 0) + { + base.cursor = base.limit - v_1; + break lab0; + } + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.ket = base.cursor; + among_var = base.find_among_b(a_2); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + if (!base.slice_from("ss")) + { + return false; + } + break; + case 2: + lab1: { + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + { + /** @const */ var /** number */ c1 = base.cursor - 2; + if (c1 < base.limit_backward) + { + break lab2; + } + base.cursor = c1; + } + if (!base.slice_from("i")) + { + return false; + } + break lab1; + } + base.cursor = base.limit - v_2; + if (!base.slice_from("ie")) + { + return false; + } + } + break; + case 3: + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1b() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_5); + base.bra = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + switch (among_var) { + case 1: + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + lab3: { + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + lab4: { + if (base.find_among_b(a_3) == 0) + { + break lab4; + } + if (base.cursor > base.limit_backward) + { + break lab4; + } + break lab3; + } + base.cursor = base.limit - v_3; + if (!r_R1()) + { + break lab2; + } + if (!base.slice_from("ee")) + { + return false; + } + } + } + base.cursor = base.limit - v_2; + break; + case 2: + break lab1; + case 3: + among_var = base.find_among_b(a_4); + if (among_var == 0) + { + break lab1; + } + switch (among_var) { + case 1: + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (base.cursor > base.limit_backward) + { + break lab1; + } + base.cursor = base.limit - v_4; + base.bra = base.cursor; + if (!base.slice_from("ie")) + { + return false; + } + break; + case 2: + if (base.cursor > base.limit_backward) + { + break lab1; + } + break; + } + break; + } + break lab0; + } + base.cursor = base.limit - v_1; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + base.cursor = base.limit - v_5; + if (!base.slice_del()) + { + return false; + } + base.ket = base.cursor; + base.bra = base.cursor; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + among_var = base.find_among_b(a_6); + switch (among_var) { + case 1: + if (!base.slice_from("e")) + { + return false; + } + return false; + case 2: + { + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + lab5: { + if (!(base.in_grouping_b(g_aeo, 97, 111))) + { + break lab5; + } + if (base.cursor > base.limit_backward) + { + break lab5; + } + return false; + } + base.cursor = base.limit - v_7; + } + break; + case 3: + if (base.cursor != I_p1) + { + return false; + } + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + if (!r_shortv()) + { + return false; + } + base.cursor = base.limit - v_8; + if (!base.slice_from("e")) + { + return false; + } + return false; + } + base.cursor = base.limit - v_6; + base.ket = base.cursor; + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1c() { + base.ket = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("y"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("Y"))) + { + return false; + } + } + base.bra = base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + return false; + } + lab2: { + if (base.cursor > base.limit_backward) + { + break lab2; + } + return false; + } + if (!base.slice_from("i")) + { + return false; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_2() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_7); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ence")) + { + return false; + } + break; + case 3: + if (!base.slice_from("ance")) + { + return false; + } + break; + case 4: + if (!base.slice_from("able")) + { + return false; + } + break; + case 5: + if (!base.slice_from("ent")) + { + return false; + } + break; + case 6: + if (!base.slice_from("ize")) + { + return false; + } + break; + case 7: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 8: + if (!base.slice_from("al")) + { + return false; + } + break; + case 9: + if (!base.slice_from("ful")) + { + return false; + } + break; + case 10: + if (!base.slice_from("ous")) + { + return false; + } + break; + case 11: + if (!base.slice_from("ive")) + { + return false; + } + break; + case 12: + if (!base.slice_from("ble")) + { + return false; + } + break; + case 13: + if (!base.slice_from("og")) + { + return false; + } + break; + case 14: + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_from("og")) + { + return false; + } + break; + case 15: + if (!base.slice_from("less")) + { + return false; + } + break; + case 16: + if (!(base.in_grouping_b(g_valid_LI, 99, 116))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_3() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_8); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 3: + if (!base.slice_from("al")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ic")) + { + return false; + } + break; + case 5: + if (!base.slice_del()) + { + return false; + } + break; + case 6: + if (!r_R2()) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_4() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_9); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R2()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_del()) + { + return false; + } + break; + case 2: + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("s"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("t"))) + { + return false; + } + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_5() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_10); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + lab0: { + lab1: { + if (!r_R2()) + { + break lab1; + } + break lab0; + } + if (!r_R1()) + { + return false; + } + { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab2: { + if (!r_shortv()) + { + break lab2; + } + return false; + } + base.cursor = base.limit - v_1; + } + } + if (!base.slice_del()) + { + return false; + } + break; + case 2: + if (!r_R2()) + { + return false; + } + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_exception1() { + var /** number */ among_var; + base.bra = base.cursor; + among_var = base.find_among(a_11); + if (among_var == 0) + { + return false; + } + base.ket = base.cursor; + if (base.cursor < base.limit) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("sky")) + { + return false; + } + break; + case 2: + if (!base.slice_from("idl")) + { + return false; + } + break; + case 3: + if (!base.slice_from("gentl")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ugli")) + { + return false; + } + break; + case 5: + if (!base.slice_from("earli")) + { + return false; + } + break; + case 6: + if (!base.slice_from("onli")) + { + return false; + } + break; + case 7: + if (!base.slice_from("singl")) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_postlude() { + if (!B_Y_found) + { + return false; + } + while(true) + { + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + golab1: while(true) + { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + base.bra = base.cursor; + if (!(base.eq_s("Y"))) + { + break lab2; + } + base.ket = base.cursor; + base.cursor = v_2; + break golab1; + } + base.cursor = v_2; + if (base.cursor >= base.limit) + { + break lab0; + } + base.cursor++; + } + if (!base.slice_from("y")) + { + return false; + } + continue; + } + base.cursor = v_1; + break; + } + return true; + }; + + this.stem = /** @return {boolean} */ function() { + lab0: { + /** @const */ var /** number */ v_1 = base.cursor; + lab1: { + if (!r_exception1()) + { + break lab1; + } + break lab0; + } + base.cursor = v_1; + lab2: { + { + /** @const */ var /** number */ v_2 = base.cursor; + lab3: { + { + /** @const */ var /** number */ c1 = base.cursor + 3; + if (c1 > base.limit) + { + break lab3; + } + base.cursor = c1; + } + break lab2; + } + base.cursor = v_2; + } + break lab0; + } + base.cursor = v_1; + r_prelude(); + r_mark_regions(); + base.limit_backward = base.cursor; base.cursor = base.limit; + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + r_Step_1a(); + base.cursor = base.limit - v_3; + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + r_Step_1b(); + base.cursor = base.limit - v_4; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + r_Step_1c(); + base.cursor = base.limit - v_5; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + r_Step_2(); + base.cursor = base.limit - v_6; + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + r_Step_3(); + base.cursor = base.limit - v_7; + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + r_Step_4(); + base.cursor = base.limit - v_8; + /** @const */ var /** number */ v_9 = base.limit - base.cursor; + r_Step_5(); + base.cursor = base.limit - v_9; + base.cursor = base.limit_backward; + /** @const */ var /** number */ v_10 = base.cursor; + r_postlude(); + base.cursor = v_10; + } + return true; + }; + + /**@return{string}*/ + this['stemWord'] = function(/**string*/word) { + base.setCurrent(word); + this.stem(); + return base.getCurrent(); + }; +}; diff --git a/sphinx_html/_static/file.png b/sphinx_html/_static/file.png new file mode 100644 index 000000000..a858a410e Binary files /dev/null and b/sphinx_html/_static/file.png differ diff --git a/sphinx_html/_static/images/Ansible-Mark-RGB_Black.png b/sphinx_html/_static/images/Ansible-Mark-RGB_Black.png new file mode 100644 index 000000000..0b4e72195 Binary files /dev/null and b/sphinx_html/_static/images/Ansible-Mark-RGB_Black.png differ diff --git a/sphinx_html/_static/images/Ansible-Mark-RGB_Black.svg b/sphinx_html/_static/images/Ansible-Mark-RGB_Black.svg new file mode 100644 index 000000000..c600b6ee9 --- /dev/null +++ b/sphinx_html/_static/images/Ansible-Mark-RGB_Black.svg @@ -0,0 +1,14 @@ + + + diff --git a/sphinx_html/_static/images/Ansible-Mark-RGB_White.png b/sphinx_html/_static/images/Ansible-Mark-RGB_White.png new file mode 100644 index 000000000..5754701af Binary files /dev/null and b/sphinx_html/_static/images/Ansible-Mark-RGB_White.png differ diff --git a/sphinx_html/_static/images/Ansible-Mark-RGB_White.svg b/sphinx_html/_static/images/Ansible-Mark-RGB_White.svg new file mode 100644 index 000000000..2275aecee --- /dev/null +++ b/sphinx_html/_static/images/Ansible-Mark-RGB_White.svg @@ -0,0 +1 @@ + diff --git a/sphinx_html/_static/jquery.js b/sphinx_html/_static/jquery.js new file mode 100644 index 000000000..c4c6022f2 --- /dev/null +++ b/sphinx_html/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
      "],col:[2,"","
      "],tr:[2,"","
      "],td:[3,"","
      "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
      ",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0
      "),n("table.docutils.footnote").wrap("
      "),n("table.docutils.citation").wrap("
      "),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
      +
      Languages
      + ${languages + .map( + (translation) => ` +
      + ${translation.language.code} +
      + `, + ) + .join("\n")} +
      + `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
      +
      Versions
      + ${config.versions.active + .map( + (version) => ` +
      + ${version.slug} +
      + `, + ) + .join("\n")} +
      + `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
      +
      Downloads
      + ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
      + ${downloadsNameDisplay[name]} +
      + `, + ) + .join("\n")} +
      + `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
      + + Read the Docs + v: ${config.versions.current.slug} + + +
      +
      + ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
      +
      On Read the Docs
      +
      + Project Home +
      +
      + Builds +
      +
      + Downloads +
      +
      +
      +
      Search
      +
      +
      + +
      +
      +
      +
      + + Hosted by Read the Docs + +
      +
      + `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/sphinx_html/_static/language_data.js b/sphinx_html/_static/language_data.js new file mode 100644 index 000000000..577678642 --- /dev/null +++ b/sphinx_html/_static/language_data.js @@ -0,0 +1,13 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the set of stopwords, stemmer, scorer and splitter. + */ + +const stopwords = new Set(["a", "about", "above", "after", "again", "against", "all", "am", "an", "and", "any", "are", "aren't", "as", "at", "be", "because", "been", "before", "being", "below", "between", "both", "but", "by", "can't", "cannot", "could", "couldn't", "did", "didn't", "do", "does", "doesn't", "doing", "don't", "down", "during", "each", "few", "for", "from", "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having", "he", "he'd", "he'll", "he's", "her", "here", "here's", "hers", "herself", "him", "himself", "his", "how", "how's", "i", "i'd", "i'll", "i'm", "i've", "if", "in", "into", "is", "isn't", "it", "it's", "its", "itself", "let's", "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of", "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves", "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's", "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the", "their", "theirs", "them", "themselves", "then", "there", "there's", "these", "they", "they'd", "they'll", "they're", "they've", "this", "those", "through", "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd", "we'll", "we're", "we've", "were", "weren't", "what", "what's", "when", "when's", "where", "where's", "which", "while", "who", "who's", "whom", "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself", "yourselves"]); +window.stopwords = stopwords; // Export to global scope + + +/* Non-minified versions are copied as separate JavaScript files, if available */ +BaseStemmer=function(){this.current="",this.cursor=0,this.limit=0,this.limit_backward=0,this.bra=0,this.ket=0,this.setCurrent=function(t){this.current=t,this.cursor=0,this.limit=this.current.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},this.getCurrent=function(){return this.current},this.copy_from=function(t){this.current=t.current,this.cursor=t.cursor,this.limit=t.limit,this.limit_backward=t.limit_backward,this.bra=t.bra,this.ket=t.ket},this.in_grouping=function(t,r,i){return!(this.cursor>=this.limit||i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i))||(this.cursor++,0))},this.go_in_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.in_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward||i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i))||(this.cursor--,0))},this.go_in_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(i>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.out_grouping=function(t,r,i){return!(this.cursor>=this.limit)&&(i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i)))&&(this.cursor++,!0)},this.go_out_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.out_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward)&&(i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i)))&&(this.cursor--,!0)},this.go_out_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(s<=i&&r<=s&&0!=(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.eq_s=function(t){return!(this.limit-this.cursor>>1),o=0,a=e=(l=t[r])[0].length){if(this.cursor=s+l[0].length,l.length<4)return l[2];var g=l[3](this);if(this.cursor=s+l[0].length,g)return l[2]}}while(0<=(r=l[1]));return 0},this.find_among_b=function(t){for(var r=0,i=t.length,s=this.cursor,h=this.limit_backward,e=0,n=0,c=!1;;){for(var u,o=r+(i-r>>1),a=0,l=e=(u=t[r])[0].length){if(this.cursor=s-u[0].length,u.length<4)return u[2];var g=u[3](this);if(this.cursor=s-u[0].length,g)return u[2]}}while(0<=(r=u[1]));return 0},this.replace_s=function(t,r,i){var s=i.length-(r-t);return this.current=this.current.slice(0,t)+i+this.current.slice(r),this.limit+=s,this.cursor>=r?this.cursor+=s:this.cursor>t&&(this.cursor=t),s},this.slice_check=function(){return!(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>this.current.length)},this.slice_from=function(t){var r=!1;return this.slice_check()&&(this.replace_s(this.bra,this.ket,t),r=!0),r},this.slice_del=function(){return this.slice_from("")},this.insert=function(t,r,i){r=this.replace_s(t,r,i);t<=this.bra&&(this.bra+=r),t<=this.ket&&(this.ket+=r)},this.slice_to=function(){var t="";return t=this.slice_check()?this.current.slice(this.bra,this.ket):t},this.assign_to=function(){return this.current.slice(0,this.limit)}}; +var EnglishStemmer=function(){var a=new BaseStemmer,c=[["arsen",-1,-1],["commun",-1,-1],["emerg",-1,-1],["gener",-1,-1],["later",-1,-1],["organ",-1,-1],["past",-1,-1],["univers",-1,-1]],o=[["'",-1,1],["'s'",0,1],["'s",-1,1]],u=[["ied",-1,2],["s",-1,3],["ies",1,2],["sses",1,1],["ss",1,-1],["us",1,-1]],t=[["succ",-1,1],["proc",-1,1],["exc",-1,1]],l=[["even",-1,2],["cann",-1,2],["inn",-1,2],["earr",-1,2],["herr",-1,2],["out",-1,2],["y",-1,1]],n=[["",-1,-1],["ed",0,2],["eed",1,1],["ing",0,3],["edly",0,2],["eedly",4,1],["ingly",0,2]],f=[["",-1,3],["bb",0,2],["dd",0,2],["ff",0,2],["gg",0,2],["bl",0,1],["mm",0,2],["nn",0,2],["pp",0,2],["rr",0,2],["at",0,1],["tt",0,2],["iz",0,1]],_=[["anci",-1,3],["enci",-1,2],["ogi",-1,14],["li",-1,16],["bli",3,12],["abli",4,4],["alli",3,8],["fulli",3,9],["lessli",3,15],["ousli",3,10],["entli",3,5],["aliti",-1,8],["biliti",-1,12],["iviti",-1,11],["tional",-1,1],["ational",14,7],["alism",-1,8],["ation",-1,7],["ization",17,6],["izer",-1,6],["ator",-1,7],["iveness",-1,11],["fulness",-1,9],["ousness",-1,10],["ogist",-1,13]],m=[["icate",-1,4],["ative",-1,6],["alize",-1,3],["iciti",-1,4],["ical",-1,4],["tional",-1,1],["ational",5,2],["ful",-1,5],["ness",-1,5]],b=[["ic",-1,1],["ance",-1,1],["ence",-1,1],["able",-1,1],["ible",-1,1],["ate",-1,1],["ive",-1,1],["ize",-1,1],["iti",-1,1],["al",-1,1],["ism",-1,1],["ion",-1,2],["er",-1,1],["ous",-1,1],["ant",-1,1],["ent",-1,1],["ment",15,1],["ement",16,1]],k=[["e",-1,1],["l",-1,2]],g=[["andes",-1,-1],["atlas",-1,-1],["bias",-1,-1],["cosmos",-1,-1],["early",-1,5],["gently",-1,3],["howe",-1,-1],["idly",-1,2],["news",-1,-1],["only",-1,6],["singly",-1,7],["skies",-1,1],["sky",-1,-1],["ugly",-1,4]],d=[17,64],v=[17,65,16,1],i=[1,17,65,208,1],w=[55,141,2],p=!1,y=0,h=0;function q(){var r=a.limit-a.cursor;return!!(a.out_grouping_b(i,89,121)&&a.in_grouping_b(v,97,121)&&a.out_grouping_b(v,97,121)||(a.cursor=a.limit-r,a.out_grouping_b(v,97,121)&&a.in_grouping_b(v,97,121)&&!(a.cursor>a.limit_backward))||(a.cursor=a.limit-r,a.eq_s_b("past")))}function z(){return h<=a.cursor}function Y(){return y<=a.cursor}this.stem=function(){var r=a.cursor;if(!(()=>{var r;if(a.bra=a.cursor,0!=(r=a.find_among(g))&&(a.ket=a.cursor,!(a.cursora.limit)a.cursor=i;else{a.cursor=e,a.cursor=r,(()=>{p=!1;var r=a.cursor;if(a.bra=a.cursor,!a.eq_s("'")||(a.ket=a.cursor,a.slice_del())){a.cursor=r;r=a.cursor;if(a.bra=a.cursor,a.eq_s("y")){if(a.ket=a.cursor,!a.slice_from("Y"))return;p=!0}a.cursor=r;for(r=a.cursor;;){var i=a.cursor;r:{for(;;){var e=a.cursor;if(a.in_grouping(v,97,121)&&(a.bra=a.cursor,a.eq_s("y"))){a.ket=a.cursor,a.cursor=e;break}if(a.cursor=e,a.cursor>=a.limit)break r;a.cursor++}if(!a.slice_from("Y"))return;p=!0;continue}a.cursor=i;break}a.cursor=r}})(),h=a.limit,y=a.limit;i=a.cursor;r:{var s=a.cursor;if(0==a.find_among(c)){if(a.cursor=s,!a.go_out_grouping(v,97,121))break r;if(a.cursor++,!a.go_in_grouping(v,97,121))break r;a.cursor++}h=a.cursor,a.go_out_grouping(v,97,121)&&(a.cursor++,a.go_in_grouping(v,97,121))&&(a.cursor++,y=a.cursor)}a.cursor=i,a.limit_backward=a.cursor,a.cursor=a.limit;var e=a.limit-a.cursor,r=((()=>{var r=a.limit-a.cursor;if(a.ket=a.cursor,0==a.find_among_b(o))a.cursor=a.limit-r;else if(a.bra=a.cursor,!a.slice_del())return;if(a.ket=a.cursor,0!=(r=a.find_among_b(u)))switch(a.bra=a.cursor,r){case 1:if(a.slice_from("ss"))break;return;case 2:r:{var i=a.limit-a.cursor,e=a.cursor-2;if(!(e{a.ket=a.cursor,o=a.find_among_b(n),a.bra=a.cursor;r:{var r=a.limit-a.cursor;i:{switch(o){case 1:var i=a.limit-a.cursor;e:{var e=a.limit-a.cursor;if(0==a.find_among_b(t)||a.cursor>a.limit_backward){if(a.cursor=a.limit-e,!z())break e;if(!a.slice_from("ee"))return}}a.cursor=a.limit-i;break;case 2:break i;case 3:if(0==(o=a.find_among_b(l)))break i;switch(o){case 1:var s=a.limit-a.cursor;if(!a.out_grouping_b(v,97,121))break i;if(a.cursor>a.limit_backward)break i;if(a.cursor=a.limit-s,a.bra=a.cursor,a.slice_from("ie"))break;return;case 2:if(a.cursor>a.limit_backward)break i}}break r}a.cursor=a.limit-r;var c=a.limit-a.cursor;if(!a.go_out_grouping_b(v,97,121))return;if(a.cursor--,a.cursor=a.limit-c,!a.slice_del())return;a.ket=a.cursor,a.bra=a.cursor;var o,c=a.limit-a.cursor;switch(o=a.find_among_b(f)){case 1:return a.slice_from("e");case 2:var u=a.limit-a.cursor;if(a.in_grouping_b(d,97,111)&&!(a.cursor>a.limit_backward))return;a.cursor=a.limit-u;break;case 3:return a.cursor!=h||(u=a.limit-a.cursor,q()&&(a.cursor=a.limit-u,a.slice_from("e")))}if(a.cursor=a.limit-c,a.ket=a.cursor,a.cursor<=a.limit_backward)return;if(a.cursor--,a.bra=a.cursor,!a.slice_del())return}})(),a.cursor=a.limit-r,a.limit-a.cursor),r=(a.ket=a.cursor,e=a.limit-a.cursor,(a.eq_s_b("y")||(a.cursor=a.limit-e,a.eq_s_b("Y")))&&(a.bra=a.cursor,a.out_grouping_b(v,97,121))&&a.cursor>a.limit_backward&&a.slice_from("i"),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(_))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ence"))break;return;case 3:if(a.slice_from("ance"))break;return;case 4:if(a.slice_from("able"))break;return;case 5:if(a.slice_from("ent"))break;return;case 6:if(a.slice_from("ize"))break;return;case 7:if(a.slice_from("ate"))break;return;case 8:if(a.slice_from("al"))break;return;case 9:if(a.slice_from("ful"))break;return;case 10:if(a.slice_from("ous"))break;return;case 11:if(a.slice_from("ive"))break;return;case 12:if(a.slice_from("ble"))break;return;case 13:if(a.slice_from("og"))break;return;case 14:if(!a.eq_s_b("l"))return;if(a.slice_from("og"))break;return;case 15:if(a.slice_from("less"))break;return;case 16:if(!a.in_grouping_b(w,99,116))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.limit-a.cursor),i=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(m))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ate"))break;return;case 3:if(a.slice_from("al"))break;return;case 4:if(a.slice_from("ic"))break;return;case 5:if(a.slice_del())break;return;case 6:if(!Y())return;if(a.slice_del())break}})(),a.cursor=a.limit-e,a.limit-a.cursor),r=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(b))&&(a.bra=a.cursor,Y()))switch(r){case 1:if(a.slice_del())break;return;case 2:var i=a.limit-a.cursor;if(!a.eq_s_b("s")&&(a.cursor=a.limit-i,!a.eq_s_b("t")))return;if(a.slice_del())break}})(),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(k)))switch(a.bra=a.cursor,r){case 1:if(!Y()){if(!z())return;var i=a.limit-a.cursor;if(q())return;a.cursor=a.limit-i}if(a.slice_del())break;return;case 2:if(!Y())return;if(!a.eq_s_b("l"))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.cursor=a.limit_backward,a.cursor);(()=>{if(p)for(;;){var r=a.cursor;r:{for(;;){var i=a.cursor;if(a.bra=a.cursor,a.eq_s("Y")){a.ket=a.cursor,a.cursor=i;break}if(a.cursor=i,a.cursor>=a.limit)break r;a.cursor++}if(a.slice_from("y"))continue;return}a.cursor=r;break}})(),a.cursor=e}}return!0},this.stemWord=function(r){return a.setCurrent(r),this.stem(),a.getCurrent()}}; +window.Stemmer = EnglishStemmer; diff --git a/sphinx_html/_static/minus.png b/sphinx_html/_static/minus.png new file mode 100644 index 000000000..d96755fda Binary files /dev/null and b/sphinx_html/_static/minus.png differ diff --git a/sphinx_html/_static/plus.png b/sphinx_html/_static/plus.png new file mode 100644 index 000000000..7107cec93 Binary files /dev/null and b/sphinx_html/_static/plus.png differ diff --git a/sphinx_html/_static/pygments.css b/sphinx_html/_static/pygments.css new file mode 100644 index 000000000..fe39d080f --- /dev/null +++ b/sphinx_html/_static/pygments.css @@ -0,0 +1,81 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block } +.highlight { background: #f8f8f8; } +.highlight .c { color: #6A737D; font-style: italic } /* Comment */ +.highlight .err { color: #A61717; background-color: #E3D2D2; border: 1px solid #F00 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .l { color: #032F62 } /* Literal */ +.highlight .n { color: #333 } /* Name */ +.highlight .o { color: #666; font-weight: bold } /* Operator */ +.highlight .p { font-weight: bold } /* Punctuation */ +.highlight .ch { color: #6A737D; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #6A737D; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #6A737D; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #6A737D; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #999; font-weight: bold; font-style: italic; background-color: #FFF0F0 } /* Comment.Special */ +.highlight .gd { color: #A00000; background-color: #FDD } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #A00 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000; background-color: #DFD } /* Generic.Inserted */ +.highlight .go { color: #333 } /* Generic.Output */ +.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #032F62 } /* Literal.Date */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070A0 } /* Literal.String */ +.highlight .na { color: #008080 } /* Name.Attribute */ +.highlight .nb { color: #0086B3 } /* Name.Builtin */ +.highlight .nc { color: #458; font-weight: bold } /* Name.Class */ +.highlight .no { color: #008080 } /* Name.Constant */ +.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #900; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #900; font-weight: bold } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #555; font-weight: bold } /* Name.Namespace */ +.highlight .nx { color: #333 } /* Name.Other */ +.highlight .py { color: #333 } /* Name.Property */ +.highlight .nt { color: #22863A; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #9960B5; font-weight: bold } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .pm { font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #BBB } /* Text.Whitespace */ +.highlight .mb { color: #099 } /* Literal.Number.Bin */ +.highlight .mf { color: #099 } /* Literal.Number.Float */ +.highlight .mh { color: #099 } /* Literal.Number.Hex */ +.highlight .mi { color: #099 } /* Literal.Number.Integer */ +.highlight .mo { color: #099 } /* Literal.Number.Oct */ +.highlight .sa { color: #D14 } /* Literal.String.Affix */ +.highlight .sb { color: #D14 } /* Literal.String.Backtick */ +.highlight .sc { color: #D14 } /* Literal.String.Char */ +.highlight .dl { color: #D14 } /* Literal.String.Delimiter */ +.highlight .sd { color: #D14; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #D14 } /* Literal.String.Double */ +.highlight .se { color: #D14; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #D14 } /* Literal.String.Heredoc */ +.highlight .si { color: #D14; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #D14 } /* Literal.String.Other */ +.highlight .sr { color: #009926 } /* Literal.String.Regex */ +.highlight .s1 { color: #D14 } /* Literal.String.Single */ +.highlight .ss { color: #990073 } /* Literal.String.Symbol */ +.highlight .bp { color: #999 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287E; font-weight: bold } /* Name.Function.Magic */ +.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */ +.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */ +.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */ +.highlight .vm { color: #BB60D5; font-weight: bold } /* Name.Variable.Magic */ +.highlight .il { color: #099 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/sphinx_html/_static/searchtools.js b/sphinx_html/_static/searchtools.js new file mode 100644 index 000000000..e29b1c754 --- /dev/null +++ b/sphinx_html/_static/searchtools.js @@ -0,0 +1,693 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +// prettier-ignore +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _escapeHTML = (text) => { + return text + .replaceAll("&", "&") + .replaceAll("<", "<") + .replaceAll(">", ">") + .replaceAll('"', """) + .replaceAll("'", "'"); +}; + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = _escapeHTML(title); + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + ` (${_escapeHTML(descr)})`; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + highlightTerms.forEach((term) => + _highlightText(listItem, term, "highlighted"), + ); + } else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor), + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + highlightTerms.forEach((term) => + _highlightText(listItem, term, "highlighted"), + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.", + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace("${resultCount}", resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5, + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => + query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter((term) => term); // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString( + htmlString, + "text/html", + ); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { + el.remove(); + }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector( + `[role="main"] ${anchor}`, + ); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`, + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template.", + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords set is from language_data.js + if (stopwords.has(queryTermLower) || queryTerm.match(/^\d+$/)) return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + localStorage.setItem( + "sphinx_highlight_terms", + [...highlightTerms].join(" "), + ); + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: ( + query, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if ( + title.toLowerCase().trim().includes(queryLower) + && queryLower.length >= title.length / 2 + ) { + for (const [file, id] of foundTitles) { + const score = Math.round( + (Scorer.title * queryLower.length) / title.length, + ); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && queryLower.length >= entry.length / 2) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round((100 * queryLower.length) / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)), + ); + + // lookup as search terms in fulltext + normalResults.push( + ...Search.performTermsSearch(searchTerms, excludedTerms), + ); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result + .slice(0, 4) + .concat([result[5]]) + .map((v) => String(v)) + .join(","); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [ + searchQuery, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ] = Search._parseQuery(query); + const results = Search._performSearch( + searchQuery, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4]; + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => objectSearchCallback(prefix, array)), + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + // find documents, if any, containing the query word in their text/title term indices + // use Object.hasOwnProperty to avoid mismatching against prototype properties + const arr = [ + { + files: terms.hasOwnProperty(word) ? terms[word] : undefined, + score: Scorer.term, + }, + { + files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, + score: Scorer.title, + }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, new Map()); + const fileScores = scoreMap.get(file); + fileScores.set(word, record.score); + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2, + ).length; + if ( + wordList.length !== searchTerms.size + && wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file + || titleTerms[term] === file + || (terms[term] || []).includes(file) + || (titleTerms[term] || []).includes(file), + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w))); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = + top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/sphinx_html/_static/sphinx_highlight.js b/sphinx_html/_static/sphinx_highlight.js new file mode 100644 index 000000000..a74e103a8 --- /dev/null +++ b/sphinx_html/_static/sphinx_highlight.js @@ -0,0 +1,159 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true; + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 + && !parent.classList.contains(className) + && !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore(span, parent.insertBefore(rest, node.nextSibling)); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect", + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target), + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms"); + // Update history only if '?highlight' is present; otherwise it + // clears text fragments (not set in window.location by the browser) + if (url.searchParams.has("highlight")) { + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + } + + // get individual terms from highlight string + const terms = highlight + .toLowerCase() + .split(/\s+/) + .filter((x) => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

      ' + + '' + + _("Hide Search Matches") + + "

      ", + ), + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms"); + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) + return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) + return; + if ( + DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + && event.key === "Escape" + ) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/sphinx_html/environment_variables.html b/sphinx_html/environment_variables.html new file mode 100644 index 000000000..b95250a91 --- /dev/null +++ b/sphinx_html/environment_variables.html @@ -0,0 +1,139 @@ + + + + + + + + + + Index of all Collection Environment Variables — Ansible collections documentation + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + + +
      Ansible Collections Documentation
      +       +
      + + +
      + +
      +
      +
      +
        +
        • +
      • Index of all Collection Environment Variables
        • +
      • +
        • +
      +
      +
      +
      + + +
      + +
      +

      Index of all Collection Environment Variables

      +

      The following index documents all environment variables declared by plugins in collections. +Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.

      +

      No environment variables have been defined.

      +
      + + +
      +
      + + +
      + +
      + +
      +

      © Copyright Ansible contributors.

      +
      + + + + +
      +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/sphinx_html/index.html b/sphinx_html/index.html new file mode 100644 index 000000000..cbca42ab0 --- /dev/null +++ b/sphinx_html/index.html @@ -0,0 +1,168 @@ + + + + + + + + + + Fedora.Linux_System_Roles — Ansible collections documentation + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + + +
      Ansible Collections Documentation
      +       +
      + + +
      + +
      +
      +
      +
        +
        • +
      • Fedora.Linux_System_Roles
        • +
      • +
        • +
      +
      +
      +
      + + +
      + +
      +

      Fedora.Linux_System_Roles

      + +
      +

      Description

      +

      Author:

      +
        +

      • Linux System Roles

        • +
      +
      +
      +
      +
      +

      Plugin Index

      +

      There are no plugins in the fedora.linux_system_roles collection with automatically generated documentation.

      +
      +
      +

      Role Index

      +

      These are the roles in the fedora.linux_system_roles collection:

      + +
      +
      +
      +
      + + +
      +
      + + +
      + +
      + +
      +

      © Copyright Ansible contributors.

      +
      + + + + +
      +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/sphinx_html/network_role.html b/sphinx_html/network_role.html new file mode 100644 index 000000000..66ef90bce --- /dev/null +++ b/sphinx_html/network_role.html @@ -0,0 +1,2941 @@ + + + + + + + + + + linux-system-roles.network role – Configure networking — Ansible collections documentation + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + + +
      Ansible Collections Documentation
      +       +
      + + +
      + +
      +
      +
      +
        +
        • +
      • linux-system-roles.network role – Configure networking
        • +
      • +
        • +
      +
      +
      +
      + + +
      + +
      +

      linux-system-roles.network role – Configure networking

      +
      +

      Note

      +

      This role is part of the fedora.linux_system_roles collection.

      +

      It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

      +

      To install it use: ansible-galaxy collection install fedora.linux_system_roles.

      +

      To use it in a playbook, specify: linux-system-roles.network.

      +
      + +
      +

      Entry point main – Configure networking

      +
      +

      Synopsis

      +
        +

      • The network role configures network interfaces and IP settings on the target machines. It can configure Ethernet, bridge, bonded, VLAN, MacVLAN, Infiniband, wireless (WiFi), and dummy interfaces, IP configuration, and 802.1x authentication.

        • +

      • The role supports two providers, nm (NetworkManager) and initscripts. nm is used by default since RHEL 7 and initscripts on RHEL 6. The initscripts provider requires the network-scripts package, which is deprecated in RHEL 8 and dropped in RHEL 9. The provider is autodetected per host from the distribution unless set explicitly with the network_provider variable. Neither provider is tied to a distribution: nm works wherever NetworkManager API version 1.2 or later is available, and some settings require a newer API version.

        • +

      • Two mechanisms are available to configure networking. The network_connections variable manages connection profiles (one list item per profile) and is supported by both providers. The network_state variable applies an Nmstate desired state directly to the devices and is only supported by the nm provider on RHEL 8 and later.

        • +

      • Because its backend is Nmstate, network_state represents the future direction of the role, aiming to provide a more streamlined and reliable way to manage networking; most features available in NetworkManager are also available through it. For the Nmstate schema, syntax, and examples, see nmstate.io and the nmstate API documentation.

        • +

      • Warning: the network role updates or creates all connection profiles listed in network_connections on the target system, and it removes options that are present on the system but not in network_connections. Partial configuration can instead be achieved with network_state.

        • +

      • Collection requirements: to manage rpm-ostree nodes, the role requires additional modules from external collections; install them with ansible-galaxy collection install -vv -r meta/collection-requirements.yml. To manage other systems, the role has no additional requirements.

        • +

      • The role operates both on the connection profiles of devices (via network_connections) and on devices directly (via network_state). You can create generic profiles, for example a profile with a certain IP configuration, without activating them, then apply the configuration to the interface with nmcli on the target system.

        • +

      • Compatibility: both providers share the same configuration scheme, so the same playbook can be used with NetworkManager and initscripts. Not every option is handled identically by both providers, so do a test run with --check first. Creating a configuration with one provider and expecting another provider to handle it is not supported. The role also supports distributions that it treats like RHEL, such as AlmaLinux, CentOS, OracleLinux, and Rocky.

        • +

      • Invalid versus wrong configuration: the role rejects invalid configurations (test with --check first), but there is no protection against configuration that is valid but wrong. Double-check your configuration before applying it.

        • +

      • Limitations: the role does not bootstrap networking (consider ansible-pull or auto-configuring the host during installation). For the initscripts provider, deploying a profile only writes the ifcfg files; nothing happens until an up or down state issues ifup or ifdown. The initscripts provider requires dependent profiles in the right order, for example a bonding controller before its ports. Removing a NetworkManager profile also takes the connection down and may remove virtual interfaces, while removing an initscripts profile does not change the current runtime state. For NetworkManager, modifying a connection with autoconnect enabled may activate a new profile, and deleting a connection that is currently active removes the interface, so order the steps and handle the autoconnect property carefully (see rh#1401515).

        • +

      • Routing rules and named routing tables are not supported with the initscripts provider: if network_provider is set to initscripts, routing_rule entries and named table references in route are silently ignored. Use the nm provider for routing rule support.

        • +

      • Configuring dns-resolver through network_state is not supported when NetworkManager has a [global-dns] or [global-dns-domain-*] section in its configuration files (/etc/NetworkManager/NetworkManager.conf or a conf.d snippet). nmstate applies DNS through NetworkManager’s global DNS API, which NetworkManager rejects while global DNS is set in a configuration file; the role then fails with an error naming the file. Either remove the section and reload NetworkManager, or configure DNS on the connection profiles instead of dns-resolver.

        • +

      • The network_connections module is intended for internal use and integration testing only, and is not intended for direct external use.

        • +

      • For rpm-ostree systems, see the README-ostree.md file in the role.

        • +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      Parameter

      Comments

      +

      network_allow_restart

      +

      boolean

      +

      Whether the role is allowed to restart NetworkManager when a package installed for a wireless or team interface (such as NetworkManager-wifi or NetworkManager-team) requires it to be reloaded. A restart can disrupt connectivity, so the role refuses to restart NetworkManager unless this is set to true.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      network_connections

      +

      list / elements=dictionary

      +

      A list of connection profile specifications to create, modify, activate, or remove. Profiles referenced by controller or parent must appear earlier in the list than the profile referencing them. To remove every profile on the system that is not otherwise listed, add an item with no name and persistent_state set to absent.

      +

      Default: []

      +
      +

      autoconnect

      +

      boolean

      +

      Whether the profile is activated automatically. For NetworkManager, this corresponds to connection.autoconnect. For initscripts, this corresponds to ONBOOT.

      +

      Choices:

      +
        +

      • false

        • +

      • true ← (default)

        • +
      +
      +

      autoconnect_retries

      +

      integer

      +

      The number of times to try autoactivating the connection before giving up. 0 means try forever, and -1 uses the NetworkManager global default (normally 4 tries). 1 tries activation only once before blocking autoconnect until the next attempt to autoconnect. Only supported by the nm provider.

      +

      Default: -1

      +
      +

      bond

      +

      dictionary

      +

      The bonding options of a bond profile. See the kernel bonding documentation or your distribution’s nmcli documentation for valid values.

      +
      +

      ad_actor_sys_prio

      +

      integer

      +

      The 802.3ad system priority. Only valid with mode 802.3ad.

      +
      +

      ad_actor_system

      +

      string

      +

      The 802.3ad system MAC address used for the actor in LACPDU protocol packet exchanges. Only valid with mode 802.3ad.

      +
      +

      ad_select

      +

      string

      +

      The 802.3ad aggregation selection logic to use. Only valid with mode 802.3ad.

      +

      Choices:

      +
        +

      • "stable"

        • +

      • "bandwidth"

        • +

      • "count"

        • +
      +
      +

      ad_user_port_key

      +

      integer

      +

      The upper 10 bits of the port key. Only valid with mode 802.3ad.

      +
      +

      all_ports_active

      +

      boolean

      +

      Whether duplicate frames received on inactive ports are delivered (true) or dropped (false).

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      arp_all_targets

      +

      string

      +

      How many of arp_ip_target addresses must be reachable for the ARP monitor to consider a port up. Only valid with modes balance-rr, active-backup, balance-xor, or broadcast.

      +

      Choices:

      +
        +

      • "any"

        • +

      • "all"

        • +
      +
      +

      arp_interval

      +

      integer

      +

      The ARP link monitoring frequency in milliseconds. 0 disables ARP monitoring. Requires arp_ip_target to be set. Only valid with modes balance-rr, active-backup, balance-xor, or broadcast.

      +
      +

      arp_ip_target

      +

      string

      +

      The IP addresses to use as ARP monitoring peers when arp_interval is enabled. Requires arp_interval to be set.

      +
      +

      arp_validate

      +

      string

      +

      Whether ARP probes and replies should be validated in any mode that supports ARP monitoring, or whether non-ARP traffic should be filtered for link monitoring purposes. Only valid with modes balance-rr, active-backup, balance-xor, or broadcast.

      +

      Choices:

      +
        +

      • "none"

        • +

      • "active"

        • +

      • "backup"

        • +

      • "all"

        • +

      • "filter"

        • +

      • "filter_active"

        • +

      • "filter_backup"

        • +
      +
      +

      downdelay

      +

      integer

      +

      The time to wait, in milliseconds, before disabling a port after a link failure is detected. Requires miimon to be enabled.

      +
      +

      fail_over_mac

      +

      string

      +

      The policy for selecting the MAC address of the bond interface in active-backup mode.

      +

      Choices:

      +
        +

      • "none"

        • +

      • "active"

        • +

      • "follow"

        • +
      +
      +

      lacp_rate

      +

      string

      +

      The rate at which link partners are asked to transmit LACPDU packets. Only valid with mode 802.3ad.

      +

      Choices:

      +
        +

      • "slow"

        • +

      • "fast"

        • +
      +
      +

      lp_interval

      +

      integer

      +

      The number of seconds between instances where the bonding driver sends learning packets to each port’s peer switch.

      +
      +

      miimon

      +

      integer

      +

      The MII link monitoring interval in milliseconds.

      +
      +
      +

      integer

      +

      The minimum number of active links required before the carrier is asserted.

      +
      +

      mode

      +

      string

      +

      The bonding mode.

      +

      Choices:

      +
        +

      • "balance-rr" ← (default)

        • +

      • "active-backup"

        • +

      • "balance-xor"

        • +

      • "broadcast"

        • +

      • "802.3ad"

        • +

      • "balance-tlb"

        • +

      • "balance-alb"

        • +
      +
      +

      num_grat_arp

      +

      integer

      +

      The number of gratuitous ARP peer notifications to issue after a failover event.

      +
      +

      packets_per_port

      +

      integer

      +

      The number of packets to transmit through a port before moving to the next one. Only valid with mode balance-rr.

      +
      +

      peer_notif_delay

      +

      integer

      +

      The delay, in milliseconds, between each peer notification issued after a failover event. Requires miimon to be enabled and must be a multiple of miimon. Not allowed together with arp_interval.

      +
      +

      primary

      +

      string

      +

      The name of the primary port device. Only valid with modes active-backup, balance-tlb, or balance-alb.

      +
      +

      primary_reselect

      +

      string

      +

      The reselection policy for the primary port.

      +

      Choices:

      +
        +

      • "always"

        • +

      • "better"

        • +

      • "failure"

        • +
      +
      +

      resend_igmp

      +

      integer

      +

      The number of IGMP membership reports to issue after a failover event.

      +
      +

      tlb_dynamic_lb

      +

      boolean

      +

      Whether dynamic shuffling of flows is enabled. Only valid with modes balance-tlb or balance-alb.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      updelay

      +

      integer

      +

      The time to wait, in milliseconds, before enabling a port after a link recovery is detected. Requires miimon to be enabled.

      +
      +

      use_carrier

      +

      boolean

      +

      Whether the netif_carrier_ok function (true) or MII/ETHTOOL ioctls (false) are used to determine link status for miimon.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      xmit_hash_policy

      +

      string

      +

      The transmit hash policy used for port selection.

      +

      Choices:

      +
        +

      • "layer2"

        • +

      • "layer3+4"

        • +

      • "layer2+3"

        • +

      • "encap2+3"

        • +

      • "encap3+4"

        • +

      • "vlan+srcmac"

        • +
      +
      +

      check_iface_exists

      +

      boolean

      +

      Whether to check that the target interface exists before activating the connection. Only supported by the nm provider.

      +

      Choices:

      +
        +

      • false

        • +

      • true ← (default)

        • +
      +
      +

      cloned_mac

      +

      string

      +

      The MAC address strategy to apply on activation. Accepts a hardware address in the same notation as mac, or one of the special values default (honor the NetworkManager default), permanent (use the device’s permanent address), preserve (do not change the current address), random (generate a new address on every connect), or stable (generate a stable, hashed address).

      +

      Default: "default"

      +
      +

      controller

      +

      string

      +

      The name of another profile in network_connections that this profile is a port of, used for bridge, bond, and team controller devices. This refers to a profile name in the play, not an interface name or NetworkManager connection ID. Ports must not specify ip or zone settings.

      +
      +

      ethernet

      +

      dictionary

      +

      Ethernet link settings, corresponding to the ethtool utility’s link settings. Only allowed for ethernet, vlan, bridge, bond, and team types.

      +
      +

      autoneg

      +

      boolean

      +

      Whether auto-negotiation is enabled. When speed or duplex are set, autoneg must not be enabled, and when it is disabled, both speed and duplex must be set.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      duplex

      +

      string

      +

      The link duplex mode. Required together with speed when autoneg is disabled.

      +

      Choices:

      +
        +

      • "half"

        • +

      • "full"

        • +
      +
      +

      speed

      +

      integer

      +

      The link speed in Mbit/s. Required together with duplex when autoneg is disabled.

      +

      Default: 0

      +
      +

      ethtool

      +

      dictionary

      +

      Settings to enable or disable ethtool features on the device. Depending on the kernel and device, some settings might not be supported.

      +
      +

      coalesce

      +

      dictionary

      +

      A dictionary of ethtool interrupt coalescing settings. The *_low and *_high variants are only used when adaptive coalescing is enabled, applying while the measured packet rate is below pkt_rate_low or above pkt_rate_high respectively.

      +
      +

      adaptive_rx

      +

      boolean

      +

      Whether adaptive Rx interrupt coalescing is enabled, letting the driver tune the Rx coalescing parameters dynamically based on the packet rate.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      adaptive_tx

      +

      boolean

      +

      Whether adaptive Tx interrupt coalescing is enabled, letting the driver tune the Tx coalescing parameters dynamically based on the packet rate.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      pkt_rate_high

      +

      integer

      +

      The packet rate, in packets per second, above which the *_high coalescing parameters are used.

      +
      +

      pkt_rate_low

      +

      integer

      +

      The packet rate, in packets per second, below which the *_low coalescing parameters are used.

      +
      +

      rx_frames

      +

      integer

      +

      The maximum number of received packets to wait for before raising an Rx interrupt.

      +
      +

      rx_frames_high

      +

      integer

      +

      The number of received packets to wait for before raising an Rx interrupt while the packet rate is above pkt_rate_high.

      +
      +

      rx_frames_irq

      +

      integer

      +

      The maximum number of received packets to wait for before raising an Rx interrupt while the host is already servicing an interrupt.

      +
      +

      rx_frames_low

      +

      integer

      +

      The number of received packets to wait for before raising an Rx interrupt while the packet rate is below pkt_rate_low.

      +
      +

      rx_usecs

      +

      integer

      +

      The number of microseconds to wait after a packet is received before raising an Rx interrupt.

      +
      +

      rx_usecs_high

      +

      integer

      +

      The number of microseconds to wait before raising an Rx interrupt while the packet rate is above pkt_rate_high.

      +
      +

      rx_usecs_irq

      +

      integer

      +

      The number of microseconds to wait before raising an Rx interrupt while the host is already servicing an interrupt.

      +
      +

      rx_usecs_low

      +

      integer

      +

      The number of microseconds to wait before raising an Rx interrupt while the packet rate is below pkt_rate_low.

      +
      +

      sample_interval

      +

      integer

      +

      How often, in seconds, the adaptive coalescing logic samples the packet rate.

      +
      +

      stats_block_usecs

      +

      integer

      +

      The number of microseconds to wait between updates of the device’s in-memory statistics.

      +
      +

      tx_frames

      +

      integer

      +

      The maximum number of packets to transmit before raising a Tx interrupt.

      +
      +

      tx_frames_high

      +

      integer

      +

      The number of packets to transmit before raising a Tx interrupt while the packet rate is above pkt_rate_high.

      +
      +

      tx_frames_irq

      +

      integer

      +

      The maximum number of packets to transmit before raising a Tx interrupt while the host is already servicing an interrupt.

      +
      +

      tx_frames_low

      +

      integer

      +

      The number of packets to transmit before raising a Tx interrupt while the packet rate is below pkt_rate_low.

      +
      +

      tx_usecs

      +

      integer

      +

      The number of microseconds to wait after a packet is transmitted before raising a Tx interrupt.

      +
      +

      tx_usecs_high

      +

      integer

      +

      The number of microseconds to wait before raising a Tx interrupt while the packet rate is above pkt_rate_high.

      +
      +

      tx_usecs_irq

      +

      integer

      +

      The number of microseconds to wait before raising a Tx interrupt while the host is already servicing an interrupt.

      +
      +

      tx_usecs_low

      +

      integer

      +

      The number of microseconds to wait before raising a Tx interrupt while the packet rate is below pkt_rate_low.

      +
      +

      features

      +

      dictionary

      +

      A dictionary that enables (true) or disables (false) individual ethtool device features and offloads; every entry is a boolean toggle. Each key is a feature name: run ethtool -k <device> to list the features a device supports and see man 8 ethtool for the meaning of each one. The individual features are therefore not described separately below. Every feature also accepts a deprecated alias that uses dashes instead of underscores, matching the hyphen-separated feature names that ethtool and nmcli use natively (for example tx-tcp-segmentation for tx_tcp_segmentation); use the underscored name instead.

      +
      +

      esp-hw-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      esp-tx-csum-hw-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      esp_hw_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      esp_tx_csum_hw_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      fcoe-mtu

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      fcoe_mtu

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      gro

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      gso

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      highdma

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      hw-tc-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      hw_tc_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      l2-fwd-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      l2_fwd_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      loopback

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      lro

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      ntuple

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-all

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-fcs

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-gro-hw

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-udp_tunnel-port-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-vlan-filter

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-vlan-stag-filter

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx-vlan-stag-hw-parse

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_all

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_fcs

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_gro_hw

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_udp_tunnel_port_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_vlan_filter

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_vlan_stag_filter

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rx_vlan_stag_hw_parse

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rxhash

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      rxvlan

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      sg

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tls-hw-record

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tls-hw-tx-offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tls_hw_record

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tls_hw_tx_offload

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tso

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-checksum-fcoe-crc

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-checksum-ip-generic

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-checksum-ipv4

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-checksum-ipv6

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-checksum-sctp

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-esp-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-fcoe-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-gre-csum-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-gre-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-gso-partial

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-gso-robust

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-ipxip4-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-ipxip6-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-nocache-copy

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-scatter-gather

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-scatter-gather-fraglist

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-sctp-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-tcp-ecn-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-tcp-mangleid-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-tcp-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-tcp6-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-udp-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-udp_tnl-csum-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-udp_tnl-segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx-vlan-stag-hw-insert

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_checksum_fcoe_crc

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_checksum_ip_generic

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_checksum_ipv4

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_checksum_ipv6

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_checksum_sctp

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_esp_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_fcoe_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_gre_csum_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_gre_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_gso_partial

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_gso_robust

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_ipxip4_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_ipxip6_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_nocache_copy

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_scatter_gather

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_scatter_gather_fraglist

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_sctp_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_tcp6_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_tcp_ecn_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_tcp_mangleid_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_tcp_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_udp_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_udp_tnl_csum_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_udp_tnl_segmentation

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      tx_vlan_stag_hw_insert

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      txvlan

      +

      boolean

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      ring

      +

      dictionary

      +

      A dictionary of ethtool rx/tx ring buffer entry counts.

      +
      +

      rx

      +

      integer

      +

      The number of ring entries for the Rx ring.

      +
      +

      rx_jumbo

      +

      integer

      +

      The number of ring entries for the Rx Jumbo ring.

      +
      +

      rx_mini

      +

      integer

      +

      The number of ring entries for the Rx Mini ring.

      +
      +

      tx

      +

      integer

      +

      The number of ring entries for the Tx ring.

      +
      +

      force_state_change

      +

      boolean

      +

      Whether to force the runtime state change specified by state even when the role does not detect a difference between the requested and current configuration. Only meaningful together with state.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      ieee802_1x

      +

      dictionary

      +

      802.1x authentication settings for ethernet or wireless interfaces. Only supported by the nm provider. tls is currently the only supported EAP method, and the certificates and keys it references must already be deployed on the host before running the role.

      +
      +

      ca_cert

      +

      path

      +

      The absolute path to the PEM encoded certificate authority used to verify the EAP server.

      +
      +

      ca_path

      +

      path

      +

      The absolute path to a directory of 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 together with system_ca_certs.

      +
      +

      client_cert

      +

      path / required

      +

      The absolute path to the client’s PEM encoded certificate.

      +
      +

      domain_suffix_match

      +

      string

      +

      A domain name suffix that must match the domain name in the EAP server’s certificate.

      +
      +

      eap

      +

      string

      +

      The EAP method used to authenticate to the network.

      +

      Choices:

      +
        +

      • "tls" ← (default)

        • +
      +
      +

      identity

      +

      string / required

      +

      The identity string for the EAP authentication method.

      +
      +

      private_key

      +

      path / required

      +

      The absolute path to the client’s PEM or PKCS#12 encoded private key.

      +
      +

      private_key_password

      +

      string

      +

      The password protecting private_key.

      +
      +

      private_key_password_flags

      +

      list / elements=string

      +

      Flags controlling how NetworkManager manages the private key password. See the “Secret flag types” section of man 5 nm-settings for details.

      +

      Choices:

      +
        +

      • "none"

        • +

      • "agent-owned"

        • +

      • "not-saved"

        • +

      • "not-required"

        • +
      +
      +

      system_ca_certs

      +

      boolean

      +

      Whether NetworkManager should use the system’s trusted CA certificates to verify the EAP server.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      ignore_errors

      +

      boolean

      +

      Whether to ignore errors that occur while applying this specific connection profile and continue applying the remaining profiles instead of failing the play.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      infiniband

      +

      dictionary

      +

      Settings for infiniband connections. Only supported by the nm provider.

      +
      +

      p_key

      +

      integer

      +

      The Infiniband P_Key to use for the device, a 16-bit unsigned integer with the high bit set for “full membership”. The values 0x0000 and 0x8000 are invalid. If set, mac or parent must also be set, and interface_name must be unset. When unset, the connection is created on the physical Infiniband fabric.

      +
      +

      transport_mode

      +

      string

      +

      The IP over Infiniband (ipoib) operation mode.

      +

      Choices:

      +
        +

      • "datagram" ← (default)

        • +

      • "connected"

        • +
      +
      +

      infiniband_p_key

      +

      integer

      +

      Deprecated alias for infiniband.p_key. Use the infiniband option instead. Cannot be combined with an infiniband dictionary.

      +
      +

      infiniband_transport_mode

      +

      string

      +

      Deprecated alias for infiniband.transport_mode. Use the infiniband option instead. Cannot be combined with an infiniband dictionary.

      +

      Choices:

      +
        +

      • "datagram"

        • +

      • "connected"

        • +
      +
      +

      interface_name

      +

      string

      +

      The name of the networking interface that the profile is restricted to or, for virtual devices, the name of the interface to create. Only allowed for ethernet and infiniband when mac is not set. Set to an empty string ("") to leave the profile unrestricted to a specific interface. Defaults to the profile name for most types, except that bond, bridge, macvlan, team, and vlan require an explicit interface_name.

      +
      +

      ip

      +

      dictionary

      +

      The IP configuration of the profile. Ports of bridge, bond, or team devices cannot specify ip settings.

      +
      +

      address

      +

      list / elements=any

      +

      A list of static IP addresses to assign. Each item is either a string in <address>/<prefix> notation, for example 192.0.2.3/24, or a dictionary with an address key and an optional prefix key.

      +
      +

      auto6

      +

      boolean

      +

      Whether to configure IPv6 addressing using StateLess Address Auto Configuration (SLAAC). If unset, defaults to true unless static IPv6 addresses are configured in address.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      auto_gateway

      +

      boolean

      +

      Whether a default route should be configured using the automatically detected default gateway. Setting this to false is equivalent to DEFROUTE=no in initscripts or ipv4.never-default/ ipv6.never-default set to yes with nmcli. If enabled, at least one of gateway4, gateway6, or DHCP/SLAAC must be in use.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      dhcp4

      +

      boolean

      +

      Whether to obtain an IPv4 address using DHCP. If unset, defaults to true unless static IPv4 addresses are configured in address.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      dhcp4_send_hostname

      +

      boolean

      +

      Whether the DHCPv4 request should include the host’s name. Only valid when dhcp4 is enabled. Only supported by the nm provider.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      dns

      +

      list / elements=string

      +

      A list of name server IP addresses for manual DNS configuration, for example 192.0.2.2.

      +
      +

      dns_options

      +

      list / elements=string

      +

      A list of DNS options as described in man 5 resolv.conf, for example rotate or timeout:1. Only supported by the nm provider.

      +
      +

      dns_priority

      +

      integer

      +

      The priority of the DNS servers configured on this connection. A lower numerical value has a higher priority. A negative value excludes name servers from connections with a higher (less negative) priority value when at least one negative priority is present.

      +

      Default: 0

      +
      +
      +

      list / elements=string

      +

      A list of DNS search domains for manual DNS configuration, for example example.com.

      +
      +

      gateway4

      +

      string

      +

      The default gateway for IPv4 packets, for example 192.0.2.1.

      +
      +

      gateway6

      +

      string

      +

      The default gateway for IPv6 packets, for example 2001:db8::1.

      +
      +

      ipv4_ignore_auto_dns

      +

      boolean

      +

      Whether to ignore IPv4 name servers and search domains obtained automatically (for example via DHCP) and only use the servers and domains specified in dns and dns_search. Not supported by the initscripts provider.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      ipv6_disabled

      +

      boolean

      +

      Whether IPv6 should be disabled for the connection. Mutually exclusive with auto6 enabled, static IPv6 addresses in address, gateway6, and route_metric6.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      ipv6_ignore_auto_dns

      +

      boolean

      +

      Whether to ignore IPv6 name servers and search domains obtained automatically and only use the servers and domains specified in dns and dns_search. Not supported by the initscripts provider.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      route

      +

      list / elements=dictionary

      +

      A list of static routes.

      +
      +

      gateway

      +

      string

      +

      The gateway address for the route. Not allowed together with type.

      +
      +

      metric

      +

      integer

      +

      The route metric.

      +

      Default: -1

      +
      +

      network

      +

      string / required

      +

      The destination network address of the route, for example 198.51.100.128. Classless inter-domain routing (CIDR) and network mask notations are not supported here; use prefix instead.

      +
      +

      prefix

      +

      integer

      +

      The prefix length of the destination network in network. Defaults to the address family’s full prefix length when not specified.

      +
      +

      src

      +

      string

      +

      The source IP address to use for the route.

      +
      +

      table

      +

      any

      +

      The routing table for the route, as a numeric table ID or the name of a table defined in /etc/iproute2/rt_tables or /etc/iproute2/rt_tables.d/*.conf. The role does not create these routing table definitions automatically. Not supported by the initscripts provider.

      +
      +

      type

      +

      string

      +

      The route type. Routes of these types do not support a gateway. If not specified, the route is a regular unicast route.

      +

      Choices:

      +
        +

      • "blackhole"

        • +

      • "prohibit"

        • +

      • "unreachable"

        • +
      +
      +

      route_append_only

      +

      boolean

      +

      Whether to append the routes in route to the routes already present on the system instead of replacing them. Setting this to true without setting route preserves the current static routes.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      route_metric4

      +

      integer

      +

      The route metric used for DHCP-assigned routes and the default IPv4 route, which also determines priority when multiple interfaces are configured. For initscripts, this sets the metric of the default route.

      +
      +

      route_metric6

      +

      integer

      +

      The route metric used for the default IPv6 route. Not supported by the initscripts provider.

      +
      +

      routing_rule

      +

      list / elements=dictionary

      +

      A list of policy routing rules, allowing packets to be routed based on fields other than the destination address.

      +
      +

      action

      +

      string

      +

      The action to take when the rule matches. table is required when action is to-table.

      +

      Choices:

      +
        +

      • "to-table" ← (default)

        • +

      • "blackhole"

        • +

      • "prohibit"

        • +

      • "unreachable"

        • +
      +
      +

      dport

      +

      any

      +

      The destination port or port range to match, for example 1000-2000. Accepts a single port number or a string in <start>-<end> notation, with valid ports ranging from 0 to 65534.

      +
      +

      family

      +

      string

      +

      The IP family of the rule. Derived from from or to when not specified.

      +

      Choices:

      +
        +

      • "ipv4"

        • +

      • "ipv6"

        • +
      +
      +

      from

      +

      any

      +

      The source address to match, for example 192.168.100.58/24. Accepts a string in <address>/<prefix> notation or a dictionary with address and prefix keys.

      +
      +

      fwmark

      +

      integer

      +

      The firewall mark value of the packet to match. Must be set together with fwmask.

      +
      +

      fwmask

      +

      integer

      +

      The firewall mask value of the packet to match. Must be set together with fwmark.

      +
      +

      iif

      +

      string

      +

      The name of the incoming interface to match.

      +
      +

      invert

      +

      boolean

      +

      Whether to invert the match of the rule, so the rule matches any packet that does not satisfy the selected match.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      ipproto

      +

      integer

      +

      The IP protocol number to match.

      +
      +

      oif

      +

      string

      +

      The name of the outgoing interface to match.

      +
      +

      priority

      +

      integer / required

      +

      The priority of the rule. A lower numerical value means higher priority.

      +
      +

      sport

      +

      any

      +

      The source port or port range to match, in the same format as dport.

      +
      +

      suppress_prefixlength

      +

      integer

      +

      Reject routing decisions with a prefix length less than or equal to the specified value. Only allowed with the to-table action.

      +
      +

      table

      +

      any

      +

      The routing table to look up for the to-table action, in the same format as route.table.

      +
      +

      to

      +

      any

      +

      The destination address to match, in the same format as from.

      +
      +

      tos

      +

      integer

      +

      The type-of-service value to match.

      +
      +

      uid

      +

      any

      +

      The user ID or user ID range to match, in the same format as dport, with valid values ranging from 0 to 4294967295.

      +
      +

      rule_append_only

      +

      boolean

      +

      Whether to append the rules in routing_rule to the routing rules already present on the system instead of replacing them.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      wait_ip

      +

      string

      +

      Which IP stack must be configured before the connection is considered activated. any waits for either stack, ipv4 and ipv6 wait for the respective stack, and ipv4+ipv6 waits for both.

      +

      Choices:

      +
        +

      • "any" ← (default)

        • +

      • "ipv4"

        • +

      • "ipv6"

        • +

      • "ipv4+ipv6"

        • +
      +
      +

      mac

      +

      string

      +

      Restricts the profile to the device with the given hardware address. Only allowed for type ethernet (6 octets) or infiniband (20 octets). Specify the value in hexadecimal notation using colons, for example "00:00:5e:00:53:5d", and quote it to avoid it being parsed as a sexagesimal number.

      +
      +

      macvlan

      +

      dictionary

      +

      Settings for macvlan connections.

      +
      +

      mode

      +

      string

      +

      The MACVLAN mode.

      +

      Choices:

      +
        +

      • "vepa"

        • +

      • "bridge" ← (default)

        • +

      • "private"

        • +

      • "passthru"

        • +

      • "source"

        • +
      +
      +

      promiscuous

      +

      boolean

      +

      Whether the underlying device is used in promiscuous mode. Can only be disabled (false) when mode is passthru.

      +

      Choices:

      +
        +

      • false

        • +

      • true ← (default)

        • +
      +
      +

      tap

      +

      boolean

      +

      Whether the device should be a MACVTAP device instead of a regular MACVLAN device.

      +

      Choices:

      +
        +

      • false ← (default)

        • +

      • true

        • +
      +
      +

      master

      +

      string

      +

      Deprecated alias for controller. Use controller instead.

      +
      +

      match

      +

      dictionary

      +

      Settings used to match the profile against devices or systems, currently only supporting path.

      +
      +

      path

      +

      list / elements=string

      +

      A list of patterns to match against the ID_PATH udev property of a device, for example pci-0000:00:03.0. Supports the alternative (|), mandatory (&), and inverted (!) modifiers, as well as *, ?, and [...] shell-style wildcards. Only supported for ethernet or infiniband profiles.

      +
      +

      mtu

      +

      integer

      +

      The maximum transmission unit of the profile’s device. The maximum allowed value depends on the device; for virtual devices it depends on the underlying device.

      +
      +

      name

      +

      string

      +

      The name that identifies the connection profile. This is not necessarily the name of the networking interface, although a profile can be associated with an interface using the same name. For NetworkManager, this corresponds to connection.id. For initscripts, this determines the ifcfg file name /etc/sysconfig/network-scripts/ifcfg-$NAME and therefore cannot contain /. Required unless persistent_state is absent, in which case an empty name matches and removes every other profile.

      +
      +

      parent

      +

      string

      +

      The name of another profile in network_connections that this profile’s device is created on top of. Used for vlan, macvlan, and infiniband (when infiniband.p_key is set).

      +
      +

      persistent_state

      +

      string

      +

      Whether the connection profile should be saved on disk. present (the default) creates or updates the profile when type is also specified. absent deletes any profile matching name.

      +

      Choices:

      +
        +

      • "present"

        • +

      • "absent"

        • +
      +
      +

      port_type

      +

      string

      +

      The type of the controller profile that this profile is a port of. Requires controller to be set. If not specified, it is derived from the type of the controller profile.

      +

      Choices:

      +
        +

      • "bridge"

        • +

      • "bond"

        • +

      • "team"

        • +
      +
      +

      slave_type

      +

      string

      +

      Deprecated alias for port_type. Use port_type instead.

      +

      Choices:

      +
        +

      • "bridge"

        • +

      • "bond"

        • +

      • "team"

        • +
      +
      +

      state

      +

      string

      +

      The runtime state of the connection profile. up activates the profile (equivalent to nmcli connection up or ifup) and down deactivates it (equivalent to nmcli connection down or ifdown). present and absent are accepted as aliases of the persistent_state values of the same name, but state and persistent_state cannot both be set on the same item. If unset, the runtime state is left unchanged.

      +

      Choices:

      +
        +

      • "up"

        • +

      • "down"

        • +

      • "present"

        • +

      • "absent"

        • +
      +
      +

      type

      +

      string

      +

      The type of the connection profile. Providing type means the profile is completely specified; without it, only the runtime state of an existing profile can be changed.

      +

      Choices:

      +
        +

      • "ethernet"

        • +

      • "infiniband"

        • +

      • "bridge"

        • +

      • "team"

        • +

      • "bond"

        • +

      • "vlan"

        • +

      • "macvlan"

        • +

      • "wireless"

        • +

      • "dummy"

        • +
      +
      +

      vlan

      +

      dictionary

      +

      Settings for vlan connections.

      +
      +

      id

      +

      integer / required

      +

      The VLAN ID, ranging from 0 to 4094.

      +
      +

      vlan_id

      +

      integer

      +

      Deprecated alias for vlan.id. Use the vlan option instead. Cannot be combined with vlan.

      +
      +

      wait

      +

      float

      +

      The number of seconds to wait for the device to finish activating when state is up. 0 starts the activation without waiting for completion, for example while a DHCP lease is obtained in the background. When unset, a suitable default timeout is used. Only supported by the nm provider and only meaningful together with state.

      +
      +

      wireless

      +

      dictionary

      +

      Settings for wireless connections, supporting WPA-PSK, WPA-EAP (802.1x), WPA3-Personal SAE, and Enhanced Open (OWE) authentication. Only supported by the nm provider.

      +
      +

      key_mgmt

      +

      string / required

      +

      The key management method used to authenticate to the network. When wpa-eap is used, 802.1x settings must also be defined in ieee802_1x.

      +

      Choices:

      +
        +

      • "owe"

        • +

      • "sae"

        • +

      • "wpa-eap"

        • +

      • "wpa-psk"

        • +
      +
      +

      password

      +

      string

      +

      The password for the network. Required when key_mgmt is wpa-psk or sae, and not allowed otherwise.

      +
      +

      ssid

      +

      string / required

      +

      The SSID of the wireless network.

      +
      +

      zone

      +

      string

      +

      The firewalld zone to associate with the interface. Ports of bridge, bond, or team devices cannot specify a zone.

      +
      +

      network_force_state_change

      +

      boolean

      +

      Whether to force the runtime state change requested by a profile’s state even when the role does not detect a difference between the requested and current configuration. Acts as the default for every item of network_connections that does not set its own force_state_change.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      network_ignore_errors

      +

      boolean

      +

      Whether to ignore errors encountered while applying a connection profile and continue applying the remaining profiles instead of failing the play. Acts as the default for every item of network_connections that does not set its own ignore_errors.

      +

      Choices:

      +
        +

      • false

        • +

      • true

        • +
      +
      +

      network_state

      +

      dictionary

      +

      The desired network state to apply directly to the devices, using the Nmstate schema (see the Nmstate examples and the nmstate API documentation). When left empty, no state is applied. Only supported by the nm provider on RHEL 8 and later. Only the top-level keys are listed below; nmstate itself validates everything nested under them, so this role does not re-validate that content.

      +

      Default: {}

      +
      +

      description

      +

      string

      +

      A human-readable description of the whole desired state. Not persisted or applied by the network backend.

      +
      +

      dns-resolver

      +

      dictionary

      +

      The desired DNS resolver configuration (search domains and servers). See the Nmstate DNS resolver schema for its exact structure. Cannot be used while NetworkManager has a [global-dns] or [global-dns-domain-*] section configured.

      +
      +

      hostname

      +

      dictionary

      +

      The desired hostname configuration. See the Nmstate hostname schema for its exact structure.

      +
      +

      interfaces

      +

      list / elements=dictionary

      +

      The desired per-interface configuration (type, state, IP addressing, and type-specific settings such as bridge, bond, or VLAN options). See the Nmstate interface schema for its exact structure.

      +
      +

      ovn

      +

      dictionary

      +

      The desired OVN (Open Virtual Network) mapping configuration. See the Nmstate OVN schema for its exact structure.

      +
      +

      ovs-db

      +

      dictionary

      +

      The desired global Open vSwitch database configuration. See the Nmstate OVS-DB schema for its exact structure.

      +
      +

      route-rules

      +

      dictionary

      +

      The desired routing rules. See the Nmstate route rules schema for its exact structure.

      +
      +

      routes

      +

      dictionary

      +

      The desired static routes. See the Nmstate routes schema for its exact structure.

      +
      +
      +
      +

      Attributes

      + + + + + + + + + + + + + + + + + +

      Attribute

      Support

      Description

      +

      check_mode

      +

      Support: full

      +

      The role can be run with --check to preview the changes it would make without applying them. Running with --check first is recommended before applying a new configuration.

      +
      +

      platform

      +

      Platforms: Fedora, EL, CentOS, RHEL, AlmaLinux, Rocky, OracleLinux

      +

      Target operating systems. The role also supports distributions that it treats like RHEL, such as AlmaLinux, CentOS, OracleLinux, and Rocky.

      +
      +
      +
      +

      Notes

      +
      +

      Note

      +
        +

      • The network_provider, network_provider_os_default, network_packages, and network_service_name variables are intentionally not listed in the parameters below, even though they appear in defaults/main.yml. Their defaults depend on facts (such as ansible_facts.services and ansible_facts.packages) that are only gathered by this role’s own tasks. Ansible resolves the current value of every declared option when it validates role arguments, and it does so before the role’s own tasks (including its fact gathering) run. Declaring those variables here would force their fact-dependent defaults to be evaluated too early and break provider autodetection for the common case where the calling playbook has not already gathered service and package facts.

        • +

      • network_ignore_errors and network_force_state_change are not set in defaults/main.yml (they are left undefined so the network_connections module can apply its own static default), but they are documented, user-facing parameters read directly in tasks/main.yml and are listed in the parameters below.

        • +
      +
      +
      +
      +

      Examples

      +
      - name: Configure an Ethernet profile with full IPv4 and IPv6 settings
+  hosts: all
+  vars:
+    network_connections:
+      - name: eth0
+        type: ethernet
+        ip:
+          route_metric4: 100
+          dhcp4: false
+          gateway4: 192.0.2.1
+          dns:
+            - 192.0.2.2
+            - 198.51.100.5
+          dns_search:
+            - example.com
+            - subdomain.example.com
+          dns_options:
+            - rotate
+            - timeout:1
+          route_metric6: -1
+          auto6: false
+          gateway6: 2001:db8::1
+          address:
+            - 192.0.2.3/24
+            - 198.51.100.3/26
+            - 2001:db8::80/7
+          route:
+            - network: 198.51.100.128
+              prefix: 26
+              gateway: 198.51.100.1
+              metric: 2
+            - network: 198.51.100.64
+              prefix: 26
+              gateway: 198.51.100.6
+              metric: 4
+          route_append_only: false
+          rule_append_only: true
+  roles:
+    - linux-system-roles.network
+
+- name: Create a bridge with a bond attached to it
+  hosts: all
+  vars:
+    network_connections:
+      - name: internal-br0
+        interface_name: br0
+        type: bridge
+        ip:
+          dhcp4: false
+          auto6: false
+      - name: br0-bond0
+        type: bond
+        interface_name: bond0
+        controller: internal-br0
+        port_type: bridge
+      - name: br0-bond0-eth1
+        type: ethernet
+        interface_name: eth1
+        controller: br0-bond0
+        port_type: bond
+  roles:
+    - linux-system-roles.network
+
+- name: Configure a VLAN on top of an Ethernet profile
+  hosts: all
+  vars:
+    network_connections:
+      - name: eth1-profile
+        autoconnect: false
+        type: ethernet
+        interface_name: eth1
+        ip:
+          dhcp4: false
+          auto6: false
+      - name: eth1.6
+        autoconnect: false
+        type: vlan
+        parent: eth1-profile
+        vlan:
+          id: 6
+        ip:
+          address:
+            - 192.0.2.5/24
+          auto6: false
+  roles:
+    - linux-system-roles.network
+
+- name: Configure a MACVLAN on top of an Ethernet profile
+  hosts: all
+  vars:
+    network_connections:
+      - name: eth0-profile
+        type: ethernet
+        interface_name: eth0
+        ip:
+          address:
+            - 192.168.0.1/24
+      - name: veth0
+        type: macvlan
+        parent: eth0-profile
+        macvlan:
+          mode: bridge
+          promiscuous: true
+          tap: false
+        ip:
+          address:
+            - 192.168.1.1/24
+  roles:
+    - linux-system-roles.network
+
+- name: Configure a WPA-PSK wireless connection
+  hosts: all
+  vars:
+    network_connections:
+      - name: wlan0
+        type: wireless
+        wireless:
+          ssid: "My WPA2-PSK Network"
+          key_mgmt: "wpa-psk"
+          # recommend vault encrypting the wireless password
+          password: "{{ vault_wifi_password }}"
+  roles:
+    - linux-system-roles.network
+
+- name: Configure 802.1x (EAP-TLS) authentication on an Ethernet profile
+  hosts: all
+  vars:
+    network_connections:
+      - name: eth0
+        type: ethernet
+        ieee802_1x:
+          identity: myhost
+          eap: tls
+          private_key: /etc/pki/tls/client.key
+          # recommend vault encrypting the private key password
+          private_key_password: "{{ vault_private_key_password }}"
+          client_cert: /etc/pki/tls/client.pem
+          ca_cert: /etc/pki/tls/cacert.pem
+          domain_suffix_match: example.com
+  roles:
+    - linux-system-roles.network
+
+- name: Apply IP addresses directly to devices with network_state
+  hosts: all
+  vars:
+    network_state:
+      interfaces:
+        - name: ethtest0
+          type: ethernet
+          state: up
+          ipv4:
+            enabled: true
+            address:
+              - ip: 192.168.122.250
+                prefix-length: 24
+            dhcp: false
+          ipv6:
+            enabled: true
+            address:
+              - ip: 2001:db8::1:1
+                prefix-length: 64
+            autoconf: false
+            dhcp: false
+  roles:
+    - linux-system-roles.network
+
+- name: Configure a static route with network_state
+  hosts: all
+  vars:
+    network_state:
+      interfaces:
+        - name: eth1
+          type: ethernet
+          state: up
+          ipv4:
+            enabled: true
+            address:
+              - ip: 192.0.2.251
+                prefix-length: 24
+            dhcp: false
+      routes:
+        config:
+          - destination: 198.51.100.0/24
+            metric: 150
+            next-hop-address: 192.0.2.251
+            next-hop-interface: eth1
+            table-id: 254
+  roles:
+    - linux-system-roles.network
+
+- name: Configure DNS search domains and servers with network_state
+  hosts: all
+  vars:
+    network_state:
+      dns-resolver:
+        config:
+          search:
+            - example.com
+            - example.org
+          server:
+            - 2001:4860:4860::8888
+            - 8.8.8.8
+  roles:
+    - linux-system-roles.network
+
      +
      +
      +
      +

      Authors

      +
        +

      • Thomas Haller

        • +

      • Till Maas

        • +
      +
      +
      +
      + + +
      +
      + + +
      + +
      + +
      +

      © Copyright Ansible contributors.

      +
      + + + + +
      +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/sphinx_html/objects.inv b/sphinx_html/objects.inv new file mode 100644 index 000000000..c6c201373 Binary files /dev/null and b/sphinx_html/objects.inv differ diff --git a/sphinx_html/search.html b/sphinx_html/search.html new file mode 100644 index 000000000..19b2048a9 --- /dev/null +++ b/sphinx_html/search.html @@ -0,0 +1,152 @@ + + + + + + + + Search — Ansible collections documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + + +
      Ansible Collections Documentation
      +       +
      + + +
      + +
      +
      +
      +
        +
        • +
      • Search
        • +
      • +
        • +
      +
      +
      +
      + + +
      + + + + +
      + +
      + +
      +
      + + +
      + +
      + +
      +

      © Copyright Ansible contributors.

      +
      + + + + +
      +
      +
      +
      +
      + + + + + + + + + \ No newline at end of file diff --git a/sphinx_html/searchindex.js b/sphinx_html/searchindex.js new file mode 100644 index 000000000..9cb9334fb --- /dev/null +++ b/sphinx_html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles":{"Attributes":[[2,"attributes"]],"Authors":[[2,"authors"]],"Description":[[1,"description"]],"Entry point main \u2013 Configure networking":[[2,"entry-point-main-configure-networking"]],"Examples":[[2,"examples"]],"Fedora.Linux_System_Roles":[[1,null]],"Index of all Collection Environment Variables":[[0,null]],"Notes":[[2,"notes"]],"Parameters":[[2,"parameters"]],"Plugin Index":[[1,"plugin-index"]],"Role Index":[[1,"role-index"]],"Synopsis":[[2,"synopsis"]],"linux-system-roles.network role \u2013 Configure networking":[[2,null]]},"docnames":["environment_variables","index","network_role"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1},"filenames":["environment_variables.rst","index.rst","network_role.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"0x0000":2,"0x8000":2,"1x":2,"3ad":2,"5d":2,"5e":2,"A":2,"Cannot":2,"Each":2,"For":2,"How":2,"If":2,"It":2,"My":2,"No":0,"Not":2,"The":[0,2],"Their":2,"There":1,"These":1,"This":2,"To":2,"When":2,"Which":2,"You":2,"_high":2,"_low":2,"abov":2,"absent":2,"absolut":2,"accept":2,"achiev":2,"act":2,"action":2,"activ":2,"actor":2,"ad_actor_sys_prio":2,"ad_actor_system":2,"ad_select":2,"ad_user_port_key":2,"adapt":2,"adaptive_rx":2,"adaptive_tx":2,"add":2,"addit":2,"address":2,"agent":2,"aggreg":2,"aim":2,"alb":2,"alia":2,"alias":2,"all_ports_act":2,"allow":2,"almalinux":2,"alreadi":2,"also":2,"altern":2,"although":2,"alway":2,"ani":2,"anoth":2,"ansibl":[0,2],"ansible_fact":2,"api":2,"appear":2,"append":2,"appli":2,"argument":2,"arp":2,"arp_all_target":2,"arp_interv":2,"arp_ip_target":2,"arp_valid":2,"ask":2,"assert":2,"assign":2,"associ":2,"attach":2,"attempt":2,"authent":2,"author":1,"auto":2,"auto6":2,"auto_gateway":2,"autoactiv":2,"autoconf":2,"autoconnect":2,"autoconnect_retri":2,"autodetect":2,"automat":[1,2],"autoneg":2,"avail":2,"avoid":2,"backend":2,"background":2,"backup":2,"balanc":2,"bandwidth":2,"base":2,"becaus":2,"befor":2,"better":2,"bit":2,"blackhol":2,"block":2,"bond":2,"bond0":2,"boolean":2,"bootstrap":2,"br0":2,"break":2,"bridg":2,"broadcast":2,"buffer":2,"ca":2,"ca_cert":2,"ca_path":2,"cacert":2,"call":2,"can":2,"care":2,"carrier":2,"case":2,"cento":2,"certain":2,"certif":2,"chang":2,"check":2,"check_iface_exist":2,"check_mod":2,"checksum":2,"choic":2,"cidr":2,"classless":2,"client":2,"client_cert":2,"cloned_mac":2,"coalesc":2,"collect":[1,2],"colon":2,"com":2,"combin":2,"comment":2,"common":2,"compat":2,"complet":2,"conf":2,"config":2,"configur":[0,1],"connect":2,"consid":2,"contain":2,"content":2,"continu":2,"control":2,"copi":2,"core":[0,2],"correspond":2,"count":2,"crc":2,"creat":2,"csum":2,"current":2,"d":2,"dash":2,"databas":2,"datagram":2,"db":2,"db8":2,"deactiv":2,"decis":2,"declar":[0,2],"default":2,"defin":[0,2],"definit":2,"defrout":2,"delay":2,"delet":2,"deliv":2,"depend":2,"deploy":2,"deprec":2,"deriv":2,"describ":2,"descript":2,"desir":2,"destin":2,"detail":2,"detect":2,"determin":2,"devic":2,"dhcp":2,"dhcp4":2,"dhcp4_send_hostnam":2,"dhcpv4":2,"dictionari":2,"differ":2,"direct":2,"directori":2,"disabl":2,"disk":2,"disrupt":2,"distribut":2,"dns":2,"dns_option":2,"dns_prioriti":2,"dns_search":2,"document":[0,1,2],"doe":2,"domain":2,"domain_suffix_match":2,"doubl":2,"downdelay":2,"dport":2,"driver":2,"drop":2,"dummi":2,"duplex":2,"duplic":2,"dure":2,"dynam":2,"eap":2,"earli":2,"earlier":2,"ecn":2,"either":2,"el":2,"element":2,"empti":2,"enabl":2,"encap2":2,"encap3":2,"encod":2,"encount":2,"encrypt":2,"end":2,"enhanc":2,"equal":2,"equival":2,"error":2,"esp":2,"esp_hw_offload":2,"esp_tx_csum_hw_offload":2,"etc":2,"eth0":2,"eth1":2,"ethernet":2,"ethtest0":2,"ethtool":2,"evalu":2,"even":2,"event":2,"everi":2,"everyth":2,"exact":2,"except":2,"exchang":2,"exclud":2,"exclus":2,"exist":2,"expect":2,"explicit":2,"extern":2,"fabric":2,"face":2,"fact":2,"fail":2,"fail_over_mac":2,"failov":2,"failur":2,"fals":2,"famili":2,"fast":2,"fcoe":2,"fcoe_mtu":2,"fcs":2,"featur":2,"field":2,"file":2,"filter":2,"filter_act":2,"filter_backup":2,"finish":2,"firewal":2,"firewalld":2,"first":2,"flag":2,"float":2,"flow":2,"follow":[0,2],"forc":2,"force_state_chang":2,"forev":2,"format":2,"fraglist":2,"frame":2,"frequenc":2,"full":2,"function":2,"futur":2,"fwd":2,"fwmark":2,"fwmask":2,"galaxi":2,"gateway":2,"gateway4":2,"gateway6":2,"gather":2,"generat":[1,2],"generic":2,"give":2,"given":2,"global":2,"gratuit":2,"gre":2,"gro":2,"gso":2,"half":2,"haller":2,"handl":2,"happen":2,"hardwar":2,"hash":2,"hexadecim":2,"high":2,"highdma":2,"higher":2,"honor":2,"hop":2,"host":2,"hostnam":2,"human":2,"hw":2,"hw_tc_offload":2,"hyphen":2,"id":2,"id_path":2,"ident":2,"identifi":2,"ieee802_1x":2,"ifcfg":2,"ifdown":2,"ifup":2,"igmp":2,"ignor":2,"ignore_error":2,"iif":2,"inact":2,"includ":2,"incom":2,"individu":2,"infiniband":2,"infiniband_p_key":2,"infiniband_transport_mod":2,"initscript":2,"insert":2,"instal":2,"instanc":2,"instead":2,"integ":2,"integr":2,"intend":2,"intent":2,"inter":2,"interfac":2,"interface_nam":2,"internal":2,"interrupt":2,"interval":2,"invalid":2,"invert":2,"io":2,"ioctl":2,"ip":2,"ipoib":2,"ipproto":2,"iproute2":2,"ipv4":2,"ipv4_ignore_auto_dn":2,"ipv6":2,"ipv6_dis":2,"ipv6_ignore_auto_dn":2,"ipxip4":2,"ipxip6":2,"issu":2,"item":2,"jumbo":2,"k":2,"kernel":2,"key":2,"key_mgmt":2,"l2":2,"l2_fwd_offload":2,"lacp_rat":2,"lacpdu":2,"later":2,"layer2":2,"layer3":2,"learn":2,"leas":2,"least":2,"leav":2,"left":2,"length":2,"less":2,"let":2,"level":2,"like":2,"limit":2,"link":2,"linux":[1,2],"list":2,"logic":2,"look":2,"loopback":2,"lower":2,"lp_interv":2,"lro":2,"maa":2,"mac":2,"machin":2,"macvlan":2,"macvtap":2,"make":2,"man":2,"manag":2,"mandatori":2,"mangleid":2,"mani":2,"manual":2,"map":2,"mark":2,"mask":2,"master":2,"match":2,"maximum":2,"may":2,"mbit":2,"md":2,"mean":2,"meaning":2,"measur":2,"mechan":2,"membership":2,"memori":2,"meta":2,"method":2,"metric":2,"microsecond":2,"might":2,"mii":2,"miimon":2,"millisecond":2,"min_link":2,"mini":2,"minimum":2,"mode":2,"modifi":2,"modul":2,"monitor":2,"move":2,"mtu":2,"multipl":2,"must":2,"mutual":2,"myhost":2,"name":2,"nativ":2,"necessarili":2,"negat":2,"negoti":2,"neither":2,"nest":2,"netif_carrier_ok":2,"network":1,"network_allow_restart":2,"network_connect":2,"network_force_state_chang":2,"network_ignore_error":2,"network_packag":2,"network_provid":2,"network_provider_os_default":2,"network_service_nam":2,"network_st":2,"networkmanag":2,"never":2,"new":2,"newer":2,"next":2,"nm":2,"nmcli":2,"nmstate":2,"nocach":2,"node":2,"non":2,"none":2,"normal":2,"notat":2,"noth":2,"notif":2,"ntupl":2,"num_grat_arp":2,"number":2,"numer":2,"obtain":2,"occur":2,"octet":2,"offload":2,"often":2,"oif":2,"onboot":2,"onc":2,"one":2,"onli":2,"open":2,"oper":2,"option":2,"oraclelinux":2,"order":2,"org":2,"ostre":2,"otherwis":2,"outgo":2,"ov":2,"ovn":2,"owe":2,"owned":2,"p_key":2,"packag":2,"packet":2,"packets_per_port":2,"parent":2,"pars":2,"part":2,"partial":2,"partner":2,"passthru":2,"password":2,"path":2,"pattern":2,"pci":2,"peer":2,"peer_notif_delay":2,"pem":2,"per":2,"perman":2,"persist":2,"persistent_st":2,"person":2,"physic":2,"pkcs":2,"pki":2,"pkt_rate_high":2,"pkt_rate_low":2,"platform":2,"play":2,"playbook":2,"plugin":0,"polici":2,"port":2,"port_typ":2,"prefix":2,"present":2,"preserv":2,"preview":2,"primari":2,"primary_reselect":2,"prioriti":2,"privat":2,"private_key":2,"private_key_password":2,"private_key_password_flag":2,"probe":2,"profil":2,"prohibit":2,"promiscu":2,"properti":2,"protect":2,"protocol":2,"provid":2,"psk":2,"pull":2,"purpos":2,"quot":2,"r":2,"rais":2,"random":2,"rang":2,"rate":2,"re":2,"reachabl":2,"read":2,"readabl":2,"readm":2,"receiv":2,"recommend":2,"record":2,"recoveri":2,"refer":2,"referenc":2,"refus":2,"regular":2,"reject":2,"reliabl":2,"reload":2,"remain":2,"remov":2,"replac":2,"repli":2,"report":2,"repres":2,"request":2,"requir":2,"reselect":2,"resend_igmp":2,"resolv":2,"respect":2,"restart":2,"restrict":2,"rh":2,"rhel":2,"right":2,"ring":2,"robust":2,"rocki":2,"rotat":2,"rout":2,"route_append_on":2,"route_metric4":2,"route_metric6":2,"routing_rul":2,"rpm":2,"rr":2,"rt_tabl":2,"rule":2,"rule_append_on":2,"run":2,"runtim":2,"rx":2,"rx_all":2,"rx_fcs":2,"rx_frame":2,"rx_frames_high":2,"rx_frames_irq":2,"rx_frames_low":2,"rx_gro_hw":2,"rx_jumbo":2,"rx_mini":2,"rx_udp_tunnel_port_offload":2,"rx_usec":2,"rx_usecs_high":2,"rx_usecs_irq":2,"rx_usecs_low":2,"rx_vlan_filt":2,"rx_vlan_stag_filt":2,"rx_vlan_stag_hw_pars":2,"rxhash":2,"rxvlan":2,"s":2,"sae":2,"sampl":2,"sample_interv":2,"satisfi":2,"save":2,"scatter":2,"schema":2,"scheme":2,"script":2,"sctp":2,"search":2,"second":2,"secret":2,"section":2,"see":2,"segment":2,"select":2,"send":2,"separ":2,"server":2,"servic":2,"set":[0,2],"sexagesim":2,"sg":2,"share":2,"shell":2,"shuffl":2,"silent":2,"sinc":2,"singl":2,"slaac":2,"slave_typ":2,"slow":2,"snippet":2,"sourc":2,"special":2,"specif":2,"specifi":2,"speed":2,"sport":2,"src":2,"srcmac":2,"ssid":2,"stabl":2,"stack":2,"stag":2,"start":2,"state":2,"stateless":2,"static":2,"statist":2,"stats_block_usec":2,"status":2,"step":2,"strategi":2,"streamlin":2,"string":2,"structur":2,"style":2,"subdomain":2,"suffix":2,"suitabl":2,"support":2,"suppress_prefixlength":2,"switch":2,"syntax":2,"sysconfig":2,"system":[1,2],"system_ca_cert":2,"tabl":2,"take":2,"tap":2,"target":2,"task":2,"tc":2,"tcp":2,"tcp6":2,"team":2,"test":2,"therefor":2,"thoma":2,"though":2,"tie":2,"till":2,"time":2,"timeout":2,"tlb":2,"tlb_dynamic_lb":2,"tls":2,"tls_hw_record":2,"tls_hw_tx_offload":2,"togeth":2,"toggl":2,"top":2,"tos":2,"traffic":2,"transmiss":2,"transmit":2,"transport_mod":2,"treat":2,"tri":2,"true":2,"trust":2,"tso":2,"tune":2,"two":2,"tx":2,"tx_checksum_fcoe_crc":2,"tx_checksum_ip_gener":2,"tx_checksum_ipv4":2,"tx_checksum_ipv6":2,"tx_checksum_sctp":2,"tx_esp_segment":2,"tx_fcoe_segment":2,"tx_frame":2,"tx_frames_high":2,"tx_frames_irq":2,"tx_frames_low":2,"tx_gre_csum_segment":2,"tx_gre_segment":2,"tx_gso_parti":2,"tx_gso_robust":2,"tx_ipxip4_segment":2,"tx_ipxip6_segment":2,"tx_nocache_copi":2,"tx_scatter_gath":2,"tx_scatter_gather_fraglist":2,"tx_sctp_segment":2,"tx_tcp6_segment":2,"tx_tcp_ecn_segment":2,"tx_tcp_mangleid_segment":2,"tx_tcp_segment":2,"tx_udp_segment":2,"tx_udp_tnl_csum_segment":2,"tx_udp_tnl_segment":2,"tx_usec":2,"tx_usecs_high":2,"tx_usecs_irq":2,"tx_usecs_low":2,"tx_vlan_stag_hw_insert":2,"txvlan":2,"type":2,"udev":2,"udp":2,"udp_tnl":2,"udp_tunnel":2,"uid":2,"unchang":2,"undefin":2,"underlying":2,"underscor":2,"unicast":2,"unit":2,"unless":2,"unreach":2,"unrestrict":2,"unset":2,"unsign":2,"updat":2,"updelay":2,"upper":2,"use":[0,2],"use_carri":2,"user":2,"util":2,"valid":2,"valu":2,"var":2,"variabl":2,"variant":2,"vault":2,"vault_private_key_password":2,"vault_wifi_password":2,"vepa":2,"verifi":2,"version":2,"versus":2,"veth0":2,"via":2,"virtual":2,"vlan":2,"vlan_id":2,"vswitch":2,"vv":2,"wait":2,"wait_ip":2,"warn":2,"way":2,"well":2,"wherev":2,"whether":2,"whole":2,"wifi":2,"wildcard":2,"wireless":2,"without":2,"wlan0":2,"work":2,"wpa":2,"wpa2":2,"wpa3":2,"write":2,"wrong":2,"xmit_hash_polici":2,"xor":2,"yes":2,"yml":2,"zone":2},"titles":["Index of all Collection Environment Variables","Fedora.Linux_System_Roles","linux-system-roles.network role \u2013 Configure networking"],"titleterms":{"attribut":2,"author":2,"collect":0,"configur":2,"descript":1,"entri":2,"environ":0,"exampl":2,"fedora":[1,2],"index":[0,1],"linux_system_rol":[1,2],"main":2,"network":2,"note":2,"paramet":2,"plugin":1,"point":2,"role":[1,2],"synopsi":2,"variabl":0}}) \ No newline at end of file diff --git a/tasks/assert_connection_vars.yml b/tasks/assert_connection_vars.yml new file mode 100644 index 000000000..556a9aa5a --- /dev/null +++ b/tasks/assert_connection_vars.yml @@ -0,0 +1,146 @@ +# SPDX-License-Identifier: BSD-3-Clause +--- +# Included once per item of `network_connections` from assert_role_vars.yml. +# `__connection` and `__conn_idx` are set by the calling loop. +# +# `ip.address`, `ip.route`, and `ip.routing_rule` are validated at runtime by +# `ArgValidatorList` (see module_utils/network_lsr/argument_validator.py), +# which conveniently also accepts a single item directly instead of a +# one-item list -- for example `ip.address: 192.0.2.1/24` is valid, not just +# `ip.address: [192.0.2.1/24]`. Role argument validation does not rewrite +# `network_connections` with the normalized value, so a bare item is still +# what reaches this file. Normalize each of them to a list in task `vars` +# so `loop:` does not fail on a non-list value. +- name: Assert ip.address items are a string or a dict with 'address' + ansible.builtin.assert: + that: + - >- + item is string + or (item is mapping and item.address is defined + and item.address is string) + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.address[{{ ansible_loop.index0 }}] + must be a string in '
      /' notation or a dict with an + 'address' key, got {{ item | type_debug }} + loop: "{{ __ip_address_list }}" + loop_control: + extended: true + vars: + __ip_address: "{{ (__connection.ip | d({})).address | d([]) }}" + __ip_address_list: "{{ [__ip_address] if __ip_address is string or __ip_address is mapping else __ip_address }}" + +- name: Assert ip.route table entries are a string or an integer + ansible.builtin.assert: + that: + - (item.table | type_debug) in ['str', 'int', 'unicode'] + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.route[{{ ansible_loop.index0 }}].table + must be a string or integer, got {{ item.table | type_debug }} + loop: "{{ __ip_route_list }}" + loop_control: + extended: true + when: item.table is defined + vars: + __ip_route: "{{ (__connection.ip | d({})).route | d([]) }}" + __ip_route_list: "{{ [__ip_route] if __ip_route is string or __ip_route is mapping else __ip_route }}" + +- name: Assert routing_rule.dport is a string range or an integer + ansible.builtin.assert: + that: + - (item.dport | type_debug) in ['str', 'int', 'unicode'] + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].dport + must be a string in '-' notation or an integer, + got {{ item.dport | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item.dport is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" + +- name: Assert routing_rule.sport is a string range or an integer + ansible.builtin.assert: + that: + - (item.sport | type_debug) in ['str', 'int', 'unicode'] + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].sport + must be a string in '-' notation or an integer, + got {{ item.sport | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item.sport is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" + +- name: Assert routing_rule.uid is a string range or an integer + ansible.builtin.assert: + that: + - (item.uid | type_debug) in ['str', 'int', 'unicode'] + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].uid + must be a string in '-' notation or an integer, + got {{ item.uid | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item.uid is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" + +- name: Assert routing_rule.from is a string or a dict with 'address' + ansible.builtin.assert: + that: + - >- + item['from'] is string + or (item['from'] is mapping and item['from'].address is defined + and item['from'].address is string) + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].from + must be a string in '
      /' notation or a dict with an + 'address' key, got {{ item['from'] | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item['from'] is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" + +- name: Assert routing_rule.to is a string or a dict with 'address' + ansible.builtin.assert: + that: + - >- + item.to is string + or (item.to is mapping and item.to.address is defined + and item.to.address is string) + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].to + must be a string in '
      /' notation or a dict with an + 'address' key, got {{ item.to | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item.to is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" + +- name: Assert routing_rule.table entries are a string or an integer + ansible.builtin.assert: + that: + - (item.table | type_debug) in ['str', 'int', 'unicode'] + fail_msg: >- + network_connections[{{ __conn_idx }}].ip.routing_rule[{{ ansible_loop.index0 }}].table + must be a string or integer, got {{ item.table | type_debug }} + loop: "{{ __ip_routing_rule_list }}" + loop_control: + extended: true + when: item.table is defined + vars: + __ip_routing_rule: "{{ (__connection.ip | d({})).routing_rule | d([]) }}" + __ip_routing_rule_list: "{{ [__ip_routing_rule] if __ip_routing_rule is string or __ip_routing_rule is mapping else __ip_routing_rule }}" diff --git a/tasks/assert_role_vars.yml b/tasks/assert_role_vars.yml new file mode 100644 index 000000000..e56ce955a --- /dev/null +++ b/tasks/assert_role_vars.yml @@ -0,0 +1,17 @@ +# SPDX-License-Identifier: BSD-3-Clause +--- +# meta/argument_specs.yml cannot fully validate the `raw`-typed fields nested +# under `network_connections[].ip`, since each of them accepts more than one +# type (for example, a string or a dict). The `network_connections` module +# itself performs comprehensive validation of these fields at runtime (see +# module_utils/network_lsr/argument_validator.py), so the checks below only +# need to catch type mistakes early, before the role starts installing +# packages or making other system changes. +- name: Validate raw-typed fields in network_connections + ansible.builtin.include_tasks: assert_connection_vars.yml + loop: "{{ network_connections }}" + loop_control: + loop_var: __connection + index_var: __conn_idx + label: "{{ __connection.name | d('unnamed') }}" + when: network_connections | length > 0 diff --git a/tasks/main.yml b/tasks/main.yml index 509caa0c1..144e27e86 100644 --- a/tasks/main.yml +++ b/tasks/main.yml @@ -4,6 +4,9 @@ - name: Ensure ansible_facts used by role include_tasks: tasks/set_facts.yml +- name: Validate role parameters + ansible.builtin.include_tasks: tasks/assert_role_vars.yml + - name: Print network provider debug: msg: "Using network provider: {{ network_provider }}" diff --git a/tests/tests_invalid_input.yml b/tests/tests_invalid_input.yml new file mode 100644 index 000000000..c4f813ed0 --- /dev/null +++ b/tests/tests_invalid_input.yml @@ -0,0 +1,507 @@ +# SPDX-License-Identifier: BSD-3-Clause +--- +# Verify meta/argument_specs.yml and tasks/assert_role_vars.yml reject bad +# parameters. Each block runs the role expecting failure; rescue records +# that outcome. +- name: Verify invalid parameters are rejected + hosts: all + tasks: + - name: Run invalid input tests + block: + # ==================================================== + # Section 1: Verify role works with valid defaults + # ==================================================== + - name: Run role with valid defaults + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + + # ==================================================== + # Section 2: argument_specs validation (Ansible 2.11+) + # ==================================================== + - name: Run argument specs validation tests + when: ansible_version.full is version("2.11", ">=") + block: + # --- Test: invalid connection type choice --- + - name: Argument specs reject invalid connection type + block: + - name: Run role with invalid connection type + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: not_a_real_type + rescue: + - name: Mark invalid connection type rejected + ansible.builtin.set_fact: + __invalid_input_type_choice_failed: true + + - name: Assert invalid connection type was rejected + ansible.builtin.assert: + that: + - __invalid_input_type_choice_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections entries + with an unknown 'type' value + + # --- Test: invalid state choice --- + - name: Argument specs reject invalid connection state + block: + - name: Run role with invalid connection state + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + state: not_a_valid_state + rescue: + - name: Mark invalid connection state rejected + ansible.builtin.set_fact: + __invalid_input_state_choice_failed: true + + - name: Assert invalid connection state was rejected + ansible.builtin.assert: + that: + - __invalid_input_state_choice_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections entries + with an unknown 'state' value + + # --- Test: bond invalid mode choice --- + - name: Argument specs reject invalid bond mode + block: + - name: Run role with invalid bond mode + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: bond0 + type: bond + interface_name: bond0 + bond: + mode: not_a_real_mode + rescue: + - name: Mark invalid bond mode rejected + ansible.builtin.set_fact: + __invalid_input_bond_mode_choice_failed: true + + - name: Assert invalid bond mode was rejected + ansible.builtin.assert: + that: + - __invalid_input_bond_mode_choice_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].bond.mode + values not in the allowed choices list + + # --- Test: wireless invalid key_mgmt choice --- + - name: Argument specs reject invalid wireless key_mgmt + block: + - name: Run role with invalid wireless key_mgmt + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: wlan0 + type: wireless + wireless: + ssid: my-network + key_mgmt: not_a_real_key_mgmt + rescue: + - name: Mark invalid wireless key_mgmt rejected + ansible.builtin.set_fact: + __invalid_input_key_mgmt_choice_failed: true + + - name: Assert invalid wireless key_mgmt was rejected + ansible.builtin.assert: + that: + - __invalid_input_key_mgmt_choice_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].wireless.key_mgmt + values not in the allowed choices list + + # --- Test: missing required vlan.id --- + - name: Argument specs reject vlan without required id + block: + - name: Run role with vlan missing id + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: vlan6 + type: vlan + interface_name: vlan6 + parent: eth0 + vlan: {} + rescue: + - name: Mark missing vlan.id rejected + ansible.builtin.set_fact: + __invalid_input_missing_vlan_id_failed: true + when: >- + 'missing required arguments' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert missing vlan.id was rejected + ansible.builtin.assert: + that: + - __invalid_input_missing_vlan_id_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].vlan + entries missing the required id field + + # --- Test: missing required wireless.ssid/key_mgmt --- + - name: Argument specs reject wireless without required fields + block: + - name: Run role with wireless missing ssid and key_mgmt + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: wlan0 + type: wireless + wireless: {} + rescue: + - name: Mark missing wireless fields rejected + ansible.builtin.set_fact: + __invalid_input_missing_wireless_failed: true + when: >- + 'missing required arguments' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert missing wireless fields was rejected + ansible.builtin.assert: + that: + - __invalid_input_missing_wireless_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].wireless + entries missing the required ssid and key_mgmt fields + + # --- Test: missing required ieee802_1x.identity --- + - name: Argument specs reject ieee802_1x without required identity + block: + - name: Run role with ieee802_1x missing identity + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ieee802_1x: + private_key: /etc/pki/tls/client.key + client_cert: /etc/pki/tls/client.pem + rescue: + - name: Mark missing ieee802_1x.identity rejected + ansible.builtin.set_fact: + __invalid_input_missing_identity_failed: true + when: >- + 'missing required arguments' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert missing ieee802_1x.identity was rejected + ansible.builtin.assert: + that: + - __invalid_input_missing_identity_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].ieee802_1x + entries missing the required identity field + + # --- Test: invalid network_allow_restart type --- + - name: Argument specs reject invalid network_allow_restart type + block: + - name: Run role with non-boolean network_allow_restart + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_allow_restart: not_a_bool + rescue: + - name: Mark invalid network_allow_restart rejected + ansible.builtin.set_fact: + __invalid_input_allow_restart_type_failed: true + + - name: Assert invalid network_allow_restart type was rejected + ansible.builtin.assert: + that: + - __invalid_input_allow_restart_type_failed | default(false) + fail_msg: >- + argument_specs should reject network_allow_restart values + that are not booleans + + # --- Test: invalid mtu type --- + - name: Argument specs reject invalid mtu type + block: + - name: Run role with non-integer mtu + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + mtu: not_an_int + rescue: + - name: Mark invalid mtu type rejected + ansible.builtin.set_fact: + __invalid_input_mtu_type_failed: true + + - name: Assert invalid mtu type was rejected + ansible.builtin.assert: + that: + - __invalid_input_mtu_type_failed | default(false) + fail_msg: >- + argument_specs should reject network_connections[].mtu + values that are not integers + + # --- Test: unknown key rejected --- + - name: Argument specs reject unknown ip key + block: + - name: Run role with unknown ip key + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + totally_bogus_key: true + rescue: + - name: Mark unknown ip key rejected + ansible.builtin.set_fact: + __invalid_input_unknown_ip_key_failed: true + + - name: Assert unknown ip key was rejected + ansible.builtin.assert: + that: + - __invalid_input_unknown_ip_key_failed | default(false) + fail_msg: >- + argument_specs should reject unknown keys nested under + network_connections[].ip + + # ==================================================== + # Section 3: assert_role_vars validation (all versions) + # ==================================================== + + # --- Test: ip.address item wrong type --- + - name: Assert rejects ip.address item as an integer + block: + - name: Run role with ip.address item as an integer + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + address: + - 12345 + rescue: + - name: Mark ip.address integer item rejected + ansible.builtin.set_fact: + __invalid_input_address_type_failed: true + when: >- + 'ip.address' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert ip.address integer item was rejected + ansible.builtin.assert: + that: + - __invalid_input_address_type_failed | default(false) + fail_msg: >- + assert_role_vars should reject network_connections[].ip.address + items that are neither a string nor a dict with an 'address' key + + # --- Test: ip.route.table wrong type --- + - name: Assert rejects ip.route.table as a boolean + block: + - name: Run role with ip.route.table as a boolean + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + route: + - network: 198.51.100.0 + prefix: 24 + table: true + rescue: + - name: Mark ip.route.table boolean rejected + ansible.builtin.set_fact: + __invalid_input_route_table_type_failed: true + when: >- + 'ip.route' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert ip.route.table boolean was rejected + ansible.builtin.assert: + that: + - __invalid_input_route_table_type_failed | default(false) + fail_msg: >- + assert_role_vars should reject network_connections[].ip.route.table + values that are not a string or an integer + + # --- Test: routing_rule.dport wrong type --- + - name: Assert rejects routing_rule.dport as a boolean + block: + - name: Run role with routing_rule.dport as a boolean + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + routing_rule: + - priority: 100 + from: 192.168.100.58/24 + table: 254 + dport: true + rescue: + - name: Mark routing_rule.dport boolean rejected + ansible.builtin.set_fact: + __invalid_input_dport_type_failed: true + when: >- + 'routing_rule' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert routing_rule.dport boolean was rejected + ansible.builtin.assert: + that: + - __invalid_input_dport_type_failed | default(false) + fail_msg: >- + assert_role_vars should reject network_connections[].ip.routing_rule.dport + values that are not a string range or an integer + + # --- Test: routing_rule.from wrong type --- + - name: Assert rejects routing_rule.from as an integer + block: + - name: Run role with routing_rule.from as an integer + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + ip: + routing_rule: + - priority: 100 + from: 12345 + table: 254 + rescue: + - name: Mark routing_rule.from integer rejected + ansible.builtin.set_fact: + __invalid_input_from_type_failed: true + when: >- + 'routing_rule' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert routing_rule.from integer was rejected + ansible.builtin.assert: + that: + - __invalid_input_from_type_failed | default(false) + fail_msg: >- + assert_role_vars should reject network_connections[].ip.routing_rule.from + values that are neither a string nor a dict with an 'address' key + + # ==================================================== + # Section 4: network_connections module runtime validation + # ==================================================== + # These constraints are enforced deep inside + # module_utils/network_lsr/argument_validator.py when the + # network_connections module actually runs, not by argument_specs.yml + # or assert_role_vars.yml. The role must run far enough to reach the + # module task for these to trigger, but it's still worth covering. + + # --- Test: integer passed to a plain str field (mac) --- + - name: Assert rejects mac given as an integer + block: + - name: Run role with mac as an integer + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + mac: 123456 + rescue: + - name: Mark integer mac rejected + ansible.builtin.set_fact: + __invalid_input_mac_int_type_failed: true + when: >- + 'mac' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert integer mac was rejected + ansible.builtin.assert: + that: + - __invalid_input_mac_int_type_failed | default(false) + fail_msg: >- + network_connections[].mac must ultimately be rejected when + given a non-string value; argument_specs.yml coerces it to a + string, and the network_connections module then rejects it as + an invalid MAC address + + # --- Test: range constraint violation (vlan.id) --- + - name: Assert rejects vlan.id outside its valid range + block: + - name: Run role with vlan.id out of range + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: eth0 + type: ethernet + - name: vlan6 + type: vlan + parent: eth0 + vlan: + id: 9999 + rescue: + - name: Mark out-of-range vlan.id rejected + ansible.builtin.set_fact: + __invalid_input_vlan_id_range_failed: true + when: >- + 'vlan' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert out-of-range vlan.id was rejected + ansible.builtin.assert: + that: + - __invalid_input_vlan_id_range_failed | default(false) + fail_msg: >- + the network_connections module should reject + network_connections[].vlan.id values outside the valid 0-4094 + range, a constraint argument_specs.yml cannot express + + # --- Test: cross-field dependency violation (wireless key_mgmt/password) --- + - name: Assert rejects wpa-psk wireless without a password + block: + - name: Run role with wpa-psk key_mgmt and no password + ansible.builtin.include_tasks: tasks/run_role_with_clear_facts.yml + vars: + network_connections: + - name: wlan0 + type: wireless + wireless: + ssid: my-network + key_mgmt: wpa-psk + rescue: + - name: Mark missing wireless password rejected + ansible.builtin.set_fact: + __invalid_input_wireless_password_dependency_failed: true + when: >- + 'wireless' in + (ansible_failed_result | default({}) | to_json) + + - name: Assert missing wireless password was rejected + ansible.builtin.assert: + that: + - __invalid_input_wireless_password_dependency_failed | default(false) + fail_msg: >- + the network_connections module should reject + network_connections[].wireless entries with key_mgmt set to + wpa-psk (or sae) but no password, a cross-field dependency + argument_specs.yml cannot express + + always: + - name: Clear test facts + ansible.builtin.set_fact: + __invalid_input_type_choice_failed: + __invalid_input_state_choice_failed: + __invalid_input_bond_mode_choice_failed: + __invalid_input_key_mgmt_choice_failed: + __invalid_input_missing_vlan_id_failed: + __invalid_input_missing_wireless_failed: + __invalid_input_missing_identity_failed: + __invalid_input_allow_restart_type_failed: + __invalid_input_mtu_type_failed: + __invalid_input_unknown_ip_key_failed: + __invalid_input_address_type_failed: + __invalid_input_route_table_type_failed: + __invalid_input_dport_type_failed: + __invalid_input_from_type_failed: + __invalid_input_mac_int_type_failed: + __invalid_input_vlan_id_range_failed: + __invalid_input_wireless_password_dependency_failed: + tags: tests::cleanup