+
+ 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 = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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 = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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/_static/language_data.js b/_static/language_data.js
new file mode 100644
index 0000000..c7fe6c6
--- /dev/null
+++ b/_static/language_data.js
@@ -0,0 +1,192 @@
+/*
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/_static/minus.png b/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/_static/minus.png differ
diff --git a/_static/plus.png b/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/_static/plus.png differ
diff --git a/_static/pygments.css b/_static/pygments.css
new file mode 100644
index 0000000..fddd181
--- /dev/null
+++ b/_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 #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .l { color: #032f62 } /* Literal */
+.highlight .n { color: #333333 } /* Name */
+.highlight .o { color: #666666; 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: #999999; font-weight: bold; font-style: italic; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .go { color: #333333 } /* 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: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #555555; font-weight: bold } /* Name.Namespace */
+.highlight .nx { color: #333333 } /* Name.Other */
+.highlight .py { color: #333333 } /* 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: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #009999 } /* Literal.Number.Bin */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sa { color: #dd1144 } /* Literal.String.Affix */
+.highlight .sb { color: #dd1144 } /* Literal.String.Backtick */
+.highlight .sc { color: #dd1144 } /* Literal.String.Char */
+.highlight .dl { color: #dd1144 } /* Literal.String.Delimiter */
+.highlight .sd { color: #dd1144; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #dd1144 } /* Literal.String.Double */
+.highlight .se { color: #dd1144; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #dd1144 } /* Literal.String.Heredoc */
+.highlight .si { color: #dd1144; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #dd1144 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #dd1144 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* 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: #009999 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/_static/searchtools.js b/_static/searchtools.js
new file mode 100644
index 0000000..2c774d1
--- /dev/null
+++ b/_static/searchtools.js
@@ -0,0 +1,632 @@
+/*
+ * 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.
+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 _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 = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // 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) // 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 array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ 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) { // 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 = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], 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, {});
+ scoreMap.get(file)[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)[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/_static/sphinx_highlight.js b/_static/sphinx_highlight.js
new file mode 100644
index 0000000..8a96c69
--- /dev/null
+++ b/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* 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")
+ 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/changelog.html b/changelog.html
new file mode 100644
index 0000000..71b007e
--- /dev/null
+++ b/changelog.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
Sophos.Sophos_Firewall Release Notes — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ Sophos.Sophos_Firewall Release Notes
+
+
+
+
+
+
+
+
+
+
+
+
+
+Topics
+
+
+
+
+
+
+This release adds modules for working with IPS and Syslog settings
+
+
+
+
+sophos.sophos_firewall.sfos_ips - Manage IPS protection (Protect > Intrusion Protection > IPS policies).
sophos.sophos_firewall.sfos_syslog - Manage Syslog servers (Configure > System services > Log settings).
+
+
+
+
+
+
+This release contains new modules for working with the SNMP agent and SNMPv3 users on Sophos Firewall
+
+
+
+
+
+
+
+This is the first proper release of the sophos.sophos_firewall
+
+
+
+
+sophos.sophos_firewall.sfos_admin_settings - Manage Admin and user settings (System > Administration).
sophos.sophos_firewall.sfos_atp - Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds).
sophos.sophos_firewall.sfos_backup - Manage Backup settings (System > Backup & firmware).
sophos.sophos_firewall.sfos_device_access_profile - Manage Device Access Profiles (System > Profiles > Device Access).
sophos.sophos_firewall.sfos_dns - Manage DNS settings (Configure > Network > DNS).
sophos.sophos_firewall.sfos_firewall_rule - Manage Firewall Rules (Protect > Rules & policies).
sophos.sophos_firewall.sfos_fqdn_host - Manage FQDN hosts (System > Hosts & services > FQDN host).
sophos.sophos_firewall.sfos_fqdn_hostgroup - Manage FQDN Host Groups (System > Hosts & services > FQDN host group).
sophos.sophos_firewall.sfos_ip_host - Manage IP Host (System > Hosts & services > IP host).
sophos.sophos_firewall.sfos_ip_hostgroup - Manage IP Hostgroup (System > Hosts & services > IP host group).
sophos.sophos_firewall.sfos_malware_protection - Manage Malware Protection (Configure > System services > Malware protection).
sophos.sophos_firewall.sfos_service - Manage Service (System > Hosts and services > Services).
sophos.sophos_firewall.sfos_service_acl_exception - Manage Local Service Exception ACL Rules (System > Administration > Device Access).
sophos.sophos_firewall.sfos_servicegroup - Manage Service Group (System > Hosts and services > Service Group).
sophos.sophos_firewall.sfos_time - Manage Date and Time settings (System > Administration > Time).
sophos.sophos_firewall.sfos_user - Manage Users (Configure > Authentication > Users).
sophos.sophos_firewall.sfos_xmlapi - Use the XML API to get, create, update, or delete settings on Sophos Firewall.
sophos.sophos_firewall.sfos_zone - Manage Zones (Configure > Network > Zones).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docsite/installation.html b/docsite/installation.html
new file mode 100644
index 0000000..16313fd
--- /dev/null
+++ b/docsite/installation.html
@@ -0,0 +1,192 @@
+
+
+
+
+
+
+
+
+
Installation — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+
+
+
+
+
+Installation
+
+Prerequisites
+The following must be installed prior to installing the module:
+
+The sophosfirewall-python module can be installed with pip
+ pip install sophosfirewall-python
+
+
+
+Install
+The Sophos Firewall Ansible Collection can be installed using the ansible-galaxy
+ ansible-galaxy collection install sophos.sophos_firewall
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docsite/setup.html b/docsite/setup.html
new file mode 100644
index 0000000..655f959
--- /dev/null
+++ b/docsite/setup.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+
+
Setup — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+
+
+
+
+
+Setup
+Prior to using the Ansible modules, the firewall must be set up to allow access to the API
+from the IP address of the system running Ansible.
+In the firewall dashboard, navigate to Backup & firmware and click on the API tab.
+Check the box to enable API Configuration, and add the Ansible controller to the Allowed IP address field.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/environment_variables.html b/environment_variables.html
new file mode 100644
index 0000000..6a3c64a
--- /dev/null
+++ b/environment_variables.html
@@ -0,0 +1,167 @@
+
+
+
+
+
+
+
+
+
+
Index of all Collection Environment Variables — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..7a6f653
--- /dev/null
+++ b/index.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+
+
+
Sophos.Sophos_Firewall — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ Sophos.Sophos_Firewall
+
+
+
+
+
+
+
+
+
+
+
+Sophos.Sophos_Firewall
+Collection version 1.2.0
+
+
+
+
+
+
+
+
+These are the plugins in the sophos.sophos_firewall collection:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000..aca6a4e
Binary files /dev/null and b/objects.inv differ
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..c24747e
--- /dev/null
+++ b/search.html
@@ -0,0 +1,180 @@
+
+
+
+
+
+
+
+
Search — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000..01fe9b6
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Authors": [[5, "authors"], [6, "authors"], [7, "authors"], [8, "authors"], [9, "authors"], [10, "authors"], [11, "authors"], [12, "authors"], [13, "authors"], [14, "authors"], [15, "authors"], [16, "authors"], [17, "authors"], [18, "authors"], [19, "authors"], [20, "authors"], [21, "authors"], [22, "authors"], [23, "authors"], [24, "authors"], [25, "authors"], [26, "authors"]], "Changelog": [[4, "changelog"]], "Collection links": [[5, "collection-links"], [6, "collection-links"], [7, "collection-links"], [8, "collection-links"], [9, "collection-links"], [10, "collection-links"], [11, "collection-links"], [12, "collection-links"], [13, "collection-links"], [14, "collection-links"], [15, "collection-links"], [16, "collection-links"], [17, "collection-links"], [18, "collection-links"], [19, "collection-links"], [20, "collection-links"], [21, "collection-links"], [22, "collection-links"], [23, "collection-links"], [24, "collection-links"], [25, "collection-links"], [26, "collection-links"]], "Description": [[4, "description"]], "Examples": [[5, "examples"], [6, "examples"], [7, "examples"], [8, "examples"], [9, "examples"], [10, "examples"], [11, "examples"], [12, "examples"], [13, "examples"], [14, "examples"], [15, "examples"], [16, "examples"], [17, "examples"], [18, "examples"], [19, "examples"], [20, "examples"], [21, "examples"], [22, "examples"], [23, "examples"], [24, "examples"], [25, "examples"], [26, "examples"]], "Index of all Collection Environment Variables": [[3, null]], "Install": [[1, "install"]], "Installation": [[1, null]], "Installation and Setup": [[4, "installation-and-setup"]], "Modules": [[4, "modules"]], "New Modules": [[0, "new-modules"], [0, "id2"], [0, "id4"]], "Parameters": [[5, "parameters"], [6, "parameters"], [7, "parameters"], [8, "parameters"], [9, "parameters"], [10, "parameters"], [11, "parameters"], [12, "parameters"], [13, "parameters"], [14, "parameters"], [15, "parameters"], [16, "parameters"], [17, "parameters"], [18, "parameters"], [19, "parameters"], [20, "parameters"], [21, "parameters"], [22, "parameters"], [23, "parameters"], [24, "parameters"], [25, "parameters"], [26, "parameters"]], "Plugin Index": [[4, "plugin-index"]], "Prerequisites": [[1, "prerequisites"]], "Release Summary": [[0, "release-summary"], [0, "id1"], [0, "id3"]], "Requirements": [[5, "requirements"], [6, "requirements"], [7, "requirements"], [8, "requirements"], [9, "requirements"], [10, "requirements"], [11, "requirements"], [12, "requirements"], [13, "requirements"], [14, "requirements"], [15, "requirements"], [16, "requirements"], [17, "requirements"], [18, "requirements"], [19, "requirements"], [20, "requirements"], [21, "requirements"], [22, "requirements"], [23, "requirements"], [24, "requirements"], [25, "requirements"], [26, "requirements"]], "Return Values": [[5, "return-values"], [6, "return-values"], [7, "return-values"], [8, "return-values"], [9, "return-values"], [10, "return-values"], [11, "return-values"], [12, "return-values"], [13, "return-values"], [14, "return-values"], [15, "return-values"], [16, "return-values"], [17, "return-values"], [18, "return-values"], [19, "return-values"], [20, "return-values"], [21, "return-values"], [22, "return-values"], [23, "return-values"], [24, "return-values"], [25, "return-values"], [26, "return-values"]], "Setup": [[2, null]], "Sophos.Sophos_Firewall": [[4, null]], "Sophos.Sophos_Firewall Release Notes": [[0, null]], "Synopsis": [[5, "synopsis"], [6, "synopsis"], [7, "synopsis"], [8, "synopsis"], [9, "synopsis"], [10, "synopsis"], [11, "synopsis"], [12, "synopsis"], [13, "synopsis"], [14, "synopsis"], [15, "synopsis"], [16, "synopsis"], [17, "synopsis"], [18, "synopsis"], [19, "synopsis"], [20, "synopsis"], [21, "synopsis"], [22, "synopsis"], [23, "synopsis"], [24, "synopsis"], [25, "synopsis"], [26, "synopsis"]], "Topics": [[0, "topics"]], "sophos.sophos_firewall.sfos_admin_settings module \u2013 Manage Admin and user settings (System > Administration)": [[5, null]], "sophos.sophos_firewall.sfos_atp module \u2013 Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds)": [[6, null]], "sophos.sophos_firewall.sfos_backup module \u2013 Manage Backup settings (System > Backup & firmware)": [[7, null]], "sophos.sophos_firewall.sfos_device_access_profile module \u2013 Manage Device Access Profiles (System > Profiles > Device Access)": [[8, null]], "sophos.sophos_firewall.sfos_dns module \u2013 Manage DNS settings (Configure > Network > DNS)": [[9, null]], "sophos.sophos_firewall.sfos_firewall_rule module \u2013 Manage Firewall Rules (Protect > Rules & policies)": [[10, null]], "sophos.sophos_firewall.sfos_fqdn_host module \u2013 Manage FQDN hosts (System > Hosts & services > FQDN host)": [[11, null]], "sophos.sophos_firewall.sfos_fqdn_hostgroup module \u2013 Manage FQDN Host Groups (System > Hosts & services > FQDN host group)": [[12, null]], "sophos.sophos_firewall.sfos_ip_host module \u2013 Manage IP Host (System > Hosts & services > IP host)": [[13, null]], "sophos.sophos_firewall.sfos_ip_hostgroup module \u2013 Manage IP Hostgroup (System > Hosts & services > IP host group)": [[14, null]], "sophos.sophos_firewall.sfos_ips module \u2013 Manage IPS protection (Protect > Intrusion Protection > IPS policies)": [[15, null]], "sophos.sophos_firewall.sfos_malware_protection module \u2013 Manage Malware Protection (Configure > System services > Malware protection)": [[16, null]], "sophos.sophos_firewall.sfos_service module \u2013 Manage Service (System > Hosts and services > Services)": [[18, null]], "sophos.sophos_firewall.sfos_service_acl_exception module \u2013 Manage Local Service Exception ACL Rules (System > Administration > Device Access)": [[17, null]], "sophos.sophos_firewall.sfos_servicegroup module \u2013 Manage Service Group (System > Hosts and services > Service Group)": [[19, null]], "sophos.sophos_firewall.sfos_snmp_agent module \u2013 Manage SNMP Agent (System > Administration > SNMP)": [[20, null]], "sophos.sophos_firewall.sfos_snmp_user module \u2013 Manage SNMPv3 User (System > Administration > SNMP)": [[21, null]], "sophos.sophos_firewall.sfos_syslog module \u2013 Manage Syslog servers (Configure > System services > Log settings)": [[22, null]], "sophos.sophos_firewall.sfos_time module \u2013 Manage Date and Time settings (System > Administration > Time)": [[23, null]], "sophos.sophos_firewall.sfos_user module \u2013 Manage Users (Configure > Authentication > Users)": [[24, null]], "sophos.sophos_firewall.sfos_xmlapi module \u2013 Use the XML API to get, create, update, or delete settings on Sophos Firewall.": [[25, null]], "sophos.sophos_firewall.sfos_zone module \u2013 Manage Zones (Configure > Network > Zones)": [[26, null]], "v1.0.0": [[0, "v1-0-0"]], "v1.1.0": [[0, "v1-1-0"]], "v1.2.0": [[0, "v1-2-0"]]}, "docnames": ["changelog", "docsite/installation", "docsite/setup", "environment_variables", "index", "sfos_admin_settings_module", "sfos_atp_module", "sfos_backup_module", "sfos_device_access_profile_module", "sfos_dns_module", "sfos_firewall_rule_module", "sfos_fqdn_host_module", "sfos_fqdn_hostgroup_module", "sfos_ip_host_module", "sfos_ip_hostgroup_module", "sfos_ips_module", "sfos_malware_protection_module", "sfos_service_acl_exception_module", "sfos_service_module", "sfos_servicegroup_module", "sfos_snmp_agent_module", "sfos_snmp_user_module", "sfos_syslog_module", "sfos_time_module", "sfos_user_module", "sfos_xmlapi_module", "sfos_zone_module"], "envversion": {"sphinx": 64, "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": ["changelog.rst", "docsite/installation.rst", "docsite/setup.rst", "environment_variables.rst", "index.rst", "sfos_admin_settings_module.rst", "sfos_atp_module.rst", "sfos_backup_module.rst", "sfos_device_access_profile_module.rst", "sfos_dns_module.rst", "sfos_firewall_rule_module.rst", "sfos_fqdn_host_module.rst", "sfos_fqdn_hostgroup_module.rst", "sfos_ip_host_module.rst", "sfos_ip_hostgroup_module.rst", "sfos_ips_module.rst", "sfos_malware_protection_module.rst", "sfos_service_acl_exception_module.rst", "sfos_service_module.rst", "sfos_servicegroup_module.rst", "sfos_snmp_agent_module.rst", "sfos_snmp_user_module.rst", "sfos_syslog_module.rst", "sfos_time_module.rst", "sfos_user_module.rst", "sfos_xmlapi_module.rst", "sfos_zone_module.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [10, 17], "0": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "00": 25, "01": 25, "1": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "10": [4, 5, 7, 13, 21, 22, 23], "100": [10, 21, 22], "104": 21, "105": 21, "11": 1, "120": 5, "16": [1, 25], "2": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "2024": 23, "255": 13, "26": 23, "28": 23, "3": [1, 5], "30": [5, 7], "33": 25, "4": 9, "443": 18, "444": 5, "4444": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "4445": 5, "49": 25, "514": 22, "56": 1, "59": 23, "60": 5, "65535": 18, "76": 25, "80": 18, "8888": 18, "9": [4, 23], "99": 10, "A": [8, 11, 18], "If": 7, "In": 2, "It": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "No": [3, 24], "The": [1, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "These": 4, "To": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "WILL": 23, "abl": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "absent": [8, 10, 11, 12, 13, 14, 17, 18, 19, 21, 22, 24, 25, 26], "accept": [10, 17], "accept_queri": 21, "access": [0, 2, 4, 22, 24], "access_points_ssid": 22, "access_time_polici": 24, "acl": [0, 4, 22], "action": [10, 12, 14, 17, 18, 19], "activ": [0, 4, 26], "ad": 17, "ad_sso": 26, "add": [0, 2, 11, 12, 14, 17, 18, 19, 21, 25], "address": [2, 7, 13, 22, 24], "admin": [0, 4, 8, 22, 26], "administr": [0, 4, 24, 26], "advanc": [6, 20], "ae": 21, "after": [5, 10], "after_rulenam": 10, "agent": [0, 4], "alert": [8, 22], "algorithm": 21, "all": [6, 22, 24], "allow": [2, 7, 24], "alwai": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "an": [12, 13, 14, 17, 18, 25], "ani": 18, "anomali": 22, "anonym": 8, "ansibl": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "anti_spam": 22, "anti_viru": 22, "antiviru": 16, "antivirus_engin": 16, "anynod": 24, "api": [0, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "api_respons": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "appli": 24, "applianc": 24, "appliance_login_restrict": 24, "applianceaccess_schedul": 24, "applic": [8, 22], "application_filt": [8, 22], "ar": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "argument": [7, 8], "assign": 20, "atp": 22, "atp_ev": 22, "attack": 22, "attempt": 5, "authent": [0, 4, 8, 21, 22, 26], "authentication_algorithm": 21, "authentication_password": 21, "author": 4, "authorized_host": 21, "autom": [5, 20], "avira": 16, "aw": 20, "backup": [0, 2, 4, 8], "backupencryptionpassword": 7, "been": 3, "befor": 10, "before_rulenam": 10, "below": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "bind": 24, "block": 5, "block_login": 5, "boolean": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "both": 6, "bottom": [10, 17], "box": 2, "bridg": 22, "bridge_acl": 22, "can": [1, 11], "captiv": 26, "captive_port": 26, "caus": 23, "central": 8, "central_manag": 8, "cert": 24, "certif": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "chang": 7, "charact": 5, "check": [2, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "choic": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "chooseipv4dnsserveroveripv6": 9, "chooseipv6dnsserveroveripv4": 9, "chooseipv6ifrequestoriginatoraddressisipv6": 9, "chooseserverbasedonincomingrequestsrecordtyp": 9, "chromebook": 26, "chromebook_sso": 26, "cisco": 24, "click": 2, "client": 26, "client_authen": 26, "clientless": 24, "clientless_polici": 24, "cloud": 8, "cloud_application_dashboard": 8, "code": 18, "collect": [0, 1, 4], "com": [4, 11, 24], "command": 1, "comment": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "common": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "complex": 5, "complexity_check": 5, "configur": [0, 2, 3, 4, 5, 6, 8, 20], "connect": [8, 22], "connect_tunnel": 8, "contact": 20, "contact_person": 20, "contain": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "content": [6, 22], "content_filt": 22, "control": 2, "core": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "creat": [0, 4, 8, 10, 11, 12, 13, 14, 17, 18, 19, 22, 24, 26], "creation": [11, 24], "critic": 22, "current": 7, "custom": 5, "daemon": 22, "dai": [7, 8, 22, 23], "daili": 7, "dashboard": [2, 8], "data": 25, "date": [0, 4, 7], "de": [8, 21], "de_anonym": 8, "debug": 22, "declar": 3, "default": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "default_log": 22, "default_permiss": 8, "defin": 3, "definit": 18, "delegate_to": [5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 23, 25], "delet": [0, 4, 8, 10, 11, 12, 13, 14, 17, 18, 19, 24, 26], "descript": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "dest_list": 17, "destin": [10, 17, 18], "detail": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "detect": 22, "dev1": 5, "devfirewal": 7, "devic": [0, 4, 22, 23], "dhcp": 9, "dictionari": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "digest": 24, "directori": [7, 26], "disabl": [5, 6, 9, 10, 15, 20, 21, 22, 24, 26], "disclaim": [5, 9], "disconnect": 8, "disconnect_live_us": 8, "discoveri": 8, "displai": [24, 26], "dmz": 26, "dn": [0, 4, 26], "dns1": 9, "dns2": 9, "dns3": 9, "dns_sourc": 9, "dnsquery_config": 9, "do": 22, "document": [3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "dos_attack": 22, "download_certif": 8, "drop": [6, 10, 17, 22], "dropped_frag": 22, "dropped_icmpredirect": 22, "dropped_sourcerout": 22, "dst_network": 10, "dst_port": 18, "dst_zone": 10, "dstnet1": 10, "dstnet2": 10, "durat": 5, "dynam": 26, "dynamic_rout": 26, "echo": 18, "element": [10, 11, 12, 14, 17, 18, 19, 21], "elseipv4": 9, "email": [7, 8, 24], "email_address": 7, "email_protect": 8, "emerg": 22, "en": 4, "enabl": [2, 5, 6, 9, 10, 15, 20, 21, 22, 24, 26], "encrypt": [7, 21, 24], "encryption_algorithm": 21, "encryption_password": [7, 21], "end": 13, "end_ip": 13, "endpoint": 22, "endpoint_statu": 22, "enforc": 5, "enforce_min_length": 5, "engin": 16, "entir": [12, 14, 18], "entri": 17, "error": 22, "europ": 23, "event": 22, "exampleprofil": 8, "exce": 5, "except": [0, 4], "execut": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "exist": 26, "extern": 8, "ey": 8, "facil": 22, "fail": 5, "fals": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "feed": [0, 4, 20], "ff": 25, "field": [2, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "file": 7, "filter": [8, 22], "firewal": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "firmwar": [0, 2, 4, 8], "first": [0, 9], "follow": [1, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "format": [18, 22], "four": 8, "four_eye_authentication_set": 8, "fqdn": [0, 4], "fqdn_group_list": 11, "fqdn_host_list": 12, "fragment": 22, "frequenc": 7, "fridai": 7, "from": [2, 12, 13, 14, 17, 18, 24], "ftp": [7, 22], "ftp_password": 7, "ftp_path": 7, "ftp_server": 7, "ftp_usernam": 7, "ftppassword": 7, "ftpuser": 7, "further": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "galaxi": [1, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "gen": 4, "get": [0, 4, 5], "group": [0, 4, 8, 11, 24], "guest": 8, "guest_user_manag": 8, "ha": 8, "have": 3, "health": 22, "heartbeat": 22, "here": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "home": 7, "host": [0, 4, 5, 6, 7, 8, 9, 10, 15, 16, 17, 20, 21, 22, 23, 24, 25, 26], "host_list": [12, 14], "host_typ": 13, "hostgroup": [0, 4, 12], "hostnam": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "hostname_set": 5, "hour": [7, 23], "http": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "https_port": 5, "i": [0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "icmp": [18, 22], "icmp_cod": 18, "icmp_errormessag": 22, "icmp_typ": 18, "icmpv6": 18, "ident": 8, "identifi": 20, "imap": 22, "includ": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "include_alpha": 5, "include_numer": 5, "include_speci": 5, "indic": [10, 12, 14, 17, 22], "inform": 22, "insert": 10, "inspect": 6, "inspect_cont": 6, "instal": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "integ": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "interfac": 5, "internet": 24, "interv": 5, "intrus": [0, 4], "invalid": 22, "invalid_traff": 22, "inventory_hostnam": [5, 6, 7, 8, 9, 15, 16, 20, 21, 22, 23, 25], "ip": [0, 2, 4, 5, 7, 8, 18, 22], "ip_address": 13, "ipmacpair_filt": 22, "ipsec": 26, "ipspoof_prevent": 22, "ipv4": 9, "ipv4_set": 9, "ipv6_set": 9, "isencryptcert": 24, "issu": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "kei": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "kernel": 22, "l2tp": 24, "lan": [10, 17, 26], "length": 5, "level": 25, "licens": 8, "like": 25, "line": 1, "list": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "live": 8, "local": [0, 4, 7, 22], "local0": 22, "local1": 22, "local2": 22, "local3": 22, "local4": 22, "local5": 22, "local6": 22, "local7": 22, "local_acl": 22, "localhost": [5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 20, 21, 22, 23, 25], "localservic": 19, "locat": 20, "log": [0, 4, 6, 8, 10], "log_set": 22, "log_view": 8, "logging_polici": 6, "login": [5, 9, 24], "login_disclaim": 5, "login_restrict": 24, "login_secur": 5, "loginsecur": 5, "logout": 5, "logout_sess": 5, "logs_report": 8, "london": 23, "lookup": 25, "mac": [22, 24, 25], "mac_bind": 24, "mac_filt": 22, "macaddress": 25, "machost": 25, "malwar": [0, 4], "mamullen13316": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "manag": [0, 4], "mask": 13, "matt": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "md5": 21, "mesh": 8, "messag": 22, "min_length": 5, "minimum": 5, "minut": [5, 7, 23], "mode": [5, 7], "modifi": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "modul": [1, 2], "mondai": 7, "month": [7, 23], "monthli": 7, "mullen": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "must": [1, 2], "myfirewallhostnam": [10, 11, 12, 13, 14, 17, 18, 19, 24, 26], "name": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "navig": 2, "need": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "net": [10, 11, 12, 13, 14, 17, 18, 19, 24, 26], "network": [0, 4, 8, 10, 13, 17, 20], "never": 7, "new": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "newer": 4, "next": 4, "none": [8, 21], "note": 4, "notif": 22, "number": [5, 18], "numer": 18, "object": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "onli": [6, 8], "op": [0, 4], "open": 24, "oper": [20, 25], "option": 25, "other": 8, "other_certificate_configur": 8, "other_vpn_configur": 8, "other_waf_configur": 8, "overview": 8, "packet": 22, "pair": 22, "part": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "password": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "password_complex": 5, "path": 7, "payload": 25, "perform": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "permiss": 8, "ping": 26, "pip": 1, "place": 11, "playbook": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "plugin": 3, "point": [8, 22], "polici": [0, 4, 6, 8, 22, 24], "policy_rul": 22, "pop": 22, "pop3": 22, "port": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "portal": [5, 26], "portal_custom_hostnam": 5, "portal_redirect_mod": 5, "posit": [10, 17], "post": 11, "pppoe": 9, "pptp": 24, "prefix": 7, "present": [8, 10, 11, 12, 13, 14, 17, 18, 19, 21, 22, 24, 25, 26], "prevent": 22, "primari": 16, "prior": [1, 2], "product": 4, "profil": [0, 4, 22, 24], "proper": 0, "protect": [0, 4, 8, 20, 22, 26], "protected_application_serv": 22, "protocol": 18, "proxi": 26, "python": [1, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "qo": 8, "quarantin": 24, "quarantine_digest": 24, "queri": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "quota": 24, "radiu": 26, "radius_sso": 26, "rang": 13, "read": 8, "readonlyal": 8, "reboot": [8, 23], "reboot_shutdown": 8, "red": 26, "redirect": [5, 22], "reject": 10, "relai": 26, "releas": 4, "remov": [10, 11, 12, 13, 14, 17, 18, 19, 21, 22, 24, 25, 26], "replac": [12, 14, 17, 18], "repli": 18, "report": 8, "reports_access": 8, "repositori": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "respons": [0, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "restor": 8, "restrict": 24, "retriev": [5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "rout": [22, 26], "rule": [0, 4, 22], "run": [2, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "saturdai": 7, "schedul": 24, "sdwan": 22, "search": 25, "second": [5, 9, 23], "secur": [5, 22], "secure_connect": 22, "security_polici": 22, "see": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "select": 22, "send": 21, "send_queri": 21, "send_trap": 21, "serial": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "server": [0, 4, 7, 8, 9], "servic": [0, 4, 8, 10, 26], "service_list": [17, 18, 19], "servicegroup": 19, "session": 5, "set": [0, 2, 3, 4, 6, 8, 15, 16, 20], "sever": 22, "sfos_admin_set": [0, 4, 8, 9], "sfos_atp": [0, 4], "sfos_backup": [0, 4], "sfos_device_access_profil": [0, 4], "sfos_dn": [0, 4], "sfos_firewall_rul": [0, 4, 26], "sfos_fqdn_host": [0, 4], "sfos_fqdn_hostgroup": [0, 4, 11], "sfos_ip": [0, 4], "sfos_ip_host": [0, 4], "sfos_ip_hostgroup": [0, 4], "sfos_malware_protect": [0, 4], "sfos_servic": [0, 4], "sfos_service_acl_except": [0, 4], "sfos_servicegroup": [0, 4], "sfos_snmp_ag": [0, 4], "sfos_snmp_us": [0, 4], "sfos_syslog": [0, 4], "sfos_tim": [0, 4], "sfos_us": [0, 4], "sfos_xmlapi": [0, 4], "sfos_zon": [0, 4], "sha256": 21, "sha512": 21, "should": [10, 11, 17, 22], "shutdown": 8, "signatur": 22, "simultan": 24, "simultaneous_login": 24, "sla": 22, "smtp": [22, 26], "smtp_relai": 26, "snmp": [0, 4, 26], "snmpv3": [0, 4], "snmpv3user": 21, "sopho": 1, "sophos_firewal": 1, "sophosfirewal": [1, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "sourc": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "source_list": 17, "source_zon": 17, "span": 5, "special": 5, "specifi": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "spoof": 22, "src_network": 10, "src_port": 18, "src_zone": 10, "srcnet1": 10, "srcnet2": 10, "ssh": [10, 26], "ssid": 22, "ssl": [22, 24], "ssl_tl": 22, "ssl_vpntunnel": 22, "sslvpn": 26, "sslvpn_polici": 24, "sso": 26, "ssw0rd": 24, "standard": 22, "start": 13, "start_ip": 13, "state": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "static": 9, "statu": [10, 22], "string": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "sundai": 7, "sup3rs3cr3tp": 24, "support": 4, "surf": 24, "surfingquota_polici": 24, "syslog": [0, 4], "system": [0, 2, 4], "system_health": 22, "system_password": 8, "tab": 2, "tag": 25, "tcp": 18, "tcporudp": 18, "test": [5, 8, 10, 11, 12, 14, 17, 19, 20, 24], "test_external_server_connect": 8, "testaclrul": 17, "testfirewal": 20, "testfqdn": 11, "testfqdngroup": 11, "testfqdnhostgroup": 12, "testhost": 13, "testhost1": [12, 14, 17], "testhost2": [12, 14, 17], "testhost3": [12, 14, 17], "testhost4": [12, 14], "testhostgroup": [12, 14], "testicmp": 18, "testmachost1": 25, "testnetwork": 13, "testrang": 13, "testservic": 18, "testservice3": 19, "testservice4": 19, "testservicegroup": 19, "testserviceweb": 18, "testsyslog": 22, "testus": 24, "testzon": 26, "thi": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "third": 9, "threat": [0, 4, 20], "thursdai": 7, "time": [0, 4, 5, 24], "timeout": 5, "timezon": 23, "tl": 22, "top": [10, 17, 25], "tracker": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "traffic": [8, 22], "traffic_discoveri": 8, "trap": 21, "true": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "trust": 6, "tuesdai": 7, "tunnel": [8, 22], "type": [13, 18, 24, 25, 26], "u": 4, "udp": [18, 22], "udp_port": 22, "under": 5, "uniqu": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "unlimit": 24, "unspecifi": [8, 22], "unsuccess": 5, "unsuccessful_attempt": 5, "untrust": 6, "up": 2, "updat": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "update_act": 17, "us": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "usag": 22, "user": [0, 4, 8, 22, 26], "user_password": 24, "user_port": 26, "user_typ": 24, "usergroupnod": 24, "usernam": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "userportal_https_port": 5, "util": 1, "verif": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "verifi": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "version": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "viewer": 8, "vpn": [5, 8, 22, 24, 26], "vpn_portal": 26, "vpnportal_https_port": 5, "waf": [8, 22], "waf_ev": 22, "wan": 10, "warn": [22, 23], "web": [5, 8, 22, 26], "web_content_polici": 22, "web_filt": [8, 22], "web_proxi": 26, "web_server_protect": 22, "webadmin": 5, "webadmin_set": 5, "wednesdai": 7, "weekli": 7, "when": [7, 8, 11, 13, 17, 18, 25], "where": 10, "whether": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "which": 5, "wireless": [8, 22, 26], "wireless_protect": [8, 26], "wireless_protection_access_point": 8, "wireless_protection_mesh": 8, "wireless_protection_network": 8, "wireless_protection_overview": 8, "wireless_protection_set": 8, "wirelessadmin": 8, "within": 5, "wizard": 8, "work": [0, 4], "write": 8, "www": 4, "x": [0, 4], "xml": [0, 4], "xml_tag": 25, "xmlapi": 25, "year": 23, "you": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "zero": [8, 22], "zero_day_protect": 8, "zerodai": 22, "zeroday_protect": 22, "zeroday_protection_ev": 22, "zone": [0, 4, 10, 17], "zone_typ": 26}, "titles": ["Sophos.Sophos_Firewall Release Notes", "Installation", "Setup", "Index of all Collection Environment Variables", "Sophos.Sophos_Firewall", "sophos.sophos_firewall.sfos_admin_settings module \u2013 Manage Admin and user settings (System > Administration)", "sophos.sophos_firewall.sfos_atp module \u2013 Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds)", "sophos.sophos_firewall.sfos_backup module \u2013 Manage Backup settings (System > Backup & firmware)", "sophos.sophos_firewall.sfos_device_access_profile module \u2013 Manage Device Access Profiles (System > Profiles > Device Access)", "sophos.sophos_firewall.sfos_dns module \u2013 Manage DNS settings (Configure > Network > DNS)", "sophos.sophos_firewall.sfos_firewall_rule module \u2013 Manage Firewall Rules (Protect > Rules & policies)", "sophos.sophos_firewall.sfos_fqdn_host module \u2013 Manage FQDN hosts (System > Hosts & services > FQDN host)", "sophos.sophos_firewall.sfos_fqdn_hostgroup module \u2013 Manage FQDN Host Groups (System > Hosts & services > FQDN host group)", "sophos.sophos_firewall.sfos_ip_host module \u2013 Manage IP Host (System > Hosts & services > IP host)", "sophos.sophos_firewall.sfos_ip_hostgroup module \u2013 Manage IP Hostgroup (System > Hosts & services > IP host group)", "sophos.sophos_firewall.sfos_ips module \u2013 Manage IPS protection (Protect > Intrusion Protection > IPS policies)", "sophos.sophos_firewall.sfos_malware_protection module \u2013 Manage Malware Protection (Configure > System services > Malware protection)", "sophos.sophos_firewall.sfos_service_acl_exception module \u2013 Manage Local Service Exception ACL Rules (System > Administration > Device Access)", "sophos.sophos_firewall.sfos_service module \u2013 Manage Service (System > Hosts and services > Services)", "sophos.sophos_firewall.sfos_servicegroup module \u2013 Manage Service Group (System > Hosts and services > Service Group)", "sophos.sophos_firewall.sfos_snmp_agent module \u2013 Manage SNMP Agent (System > Administration > SNMP)", "sophos.sophos_firewall.sfos_snmp_user module \u2013 Manage SNMPv3 User (System > Administration > SNMP)", "sophos.sophos_firewall.sfos_syslog module \u2013 Manage Syslog servers (Configure > System services > Log settings)", "sophos.sophos_firewall.sfos_time module \u2013 Manage Date and Time settings (System > Administration > Time)", "sophos.sophos_firewall.sfos_user module \u2013 Manage Users (Configure > Authentication > Users)", "sophos.sophos_firewall.sfos_xmlapi module \u2013 Use the XML API to get, create, update, or delete settings on Sophos Firewall.", "sophos.sophos_firewall.sfos_zone module \u2013 Manage Zones (Configure > Network > Zones)"], "titleterms": {"0": 0, "1": 0, "2": 0, "access": [8, 17], "acl": 17, "activ": 6, "admin": 5, "administr": [5, 17, 20, 21, 23], "agent": 20, "all": 3, "api": 25, "authent": 24, "author": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "backup": 7, "changelog": 4, "collect": [3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "configur": [9, 16, 22, 24, 26], "creat": 25, "date": 23, "delet": 25, "descript": 4, "devic": [8, 17], "dn": 9, "environ": 3, "exampl": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "except": 17, "feed": 6, "firewal": [10, 25], "firmwar": 7, "fqdn": [11, 12], "get": 25, "group": [12, 14, 19], "host": [11, 12, 13, 14, 18, 19], "hostgroup": 14, "index": [3, 4], "instal": [1, 4], "intrus": 15, "ip": [13, 14, 15], "link": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "local": 17, "log": 22, "malwar": 16, "manag": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "modul": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "network": [9, 26], "new": 0, "note": 0, "op": 6, "paramet": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "plugin": 4, "polici": [10, 15], "prerequisit": 1, "profil": 8, "protect": [6, 10, 15, 16], "releas": 0, "requir": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "respons": 6, "return": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "rule": [10, 17], "server": 22, "servic": [11, 12, 13, 14, 16, 17, 18, 19, 22], "set": [5, 7, 9, 22, 23, 25], "setup": [2, 4], "sfos_admin_set": 5, "sfos_atp": 6, "sfos_backup": 7, "sfos_device_access_profil": 8, "sfos_dn": 9, "sfos_firewall_rul": 10, "sfos_fqdn_host": 11, "sfos_fqdn_hostgroup": 12, "sfos_ip": 15, "sfos_ip_host": 13, "sfos_ip_hostgroup": 14, "sfos_malware_protect": 16, "sfos_servic": 18, "sfos_service_acl_except": 17, "sfos_servicegroup": 19, "sfos_snmp_ag": 20, "sfos_snmp_us": 21, "sfos_syslog": 22, "sfos_tim": 23, "sfos_us": 24, "sfos_xmlapi": 25, "sfos_zon": 26, "snmp": [20, 21], "snmpv3": 21, "sopho": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "sophos_firewal": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "summari": 0, "synopsi": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "syslog": 22, "system": [5, 7, 8, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23], "threat": 6, "time": 23, "topic": 0, "updat": 25, "us": 25, "user": [5, 21, 24], "v1": 0, "valu": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "variabl": 3, "x": 6, "xml": 25, "zone": 26}})
\ No newline at end of file
diff --git a/sfos_admin_settings_module.html b/sfos_admin_settings_module.html
new file mode 100644
index 0000000..547be81
--- /dev/null
+++ b/sfos_admin_settings_module.html
@@ -0,0 +1,603 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_admin_settings module – Manage Admin and user settings (System > Administration) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_admin_settings module – Manage Admin and user settings (System > Administration)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_admin_settings module – Manage Admin and user settings (System > Administration)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_admin_settings
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
hostname
+
string / required
+
+
hostname_settings
+
dictionary
+
Description field in the hostname settings
+
Hostname of the firewall
+
+
login_disclaimer
+
string
+
Enable/Disable the login disclaimer
+
Choices:
+
+
+
login_security
+
dictionary
+
Login security settings
+
Enable to block Admin login after configured number of failed attempts within configured time span.
+
Choices:
+
+
Time span within which if Admin Login attempts exceed configured Unsuccessful Attempts, then Admin Login gets blocked. (1-120 seconds).
+
+
logout_session
+
string
+
Enable to logout Admin Session after configured timeout. Specify number of minutes to enable (1-120)
+
Time interval for which Admin Login is blocked (1-60 minutes)
+
+
unsuccessful_attempt
+
string
+
Number of unsuccessful attempts
+
+
password
+
string / required
+
+
password_complexity
+
dictionary
+
Password complexity settings
+
+
complexity_check
+
string
+
Enable/Disable complexity check
+
Choices:
+
+
+
enforce_min_length
+
string
+
Enable/Disable enforcement of minimum password length
+
Choices:
+
+
Enable/Disable special character requirement
+
Choices:
+
+
+
include_numeric
+
string
+
Enable/Disable special character requirement
+
Choices:
+
+
+
include_special
+
string
+
Enable/Disable special character requirement
+
Choices:
+
+
Minimum password length
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
webadmin_settings
+
dictionary
+
Certificate used for the admin interface
+
HTTPS port for the administrative interface
+
+
portal_custom_hostname
+
string
+
+
portal_redirect_mode
+
string
+
Redirect mode
+
Choices:
+
+
+
userportal_https_port
+
string
+
HTTPS port for the user portal
+
+
vpnportal_https_port
+
string
+
HTTPS port for the VPN portal
+
+
+
+
+
+- name : Update hostname settings
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ hostname_settings :
+ hostname : sophos-firewall-dev1
+ description : Automation Testing 1
+ state : updated
+ delegate_to : localhost
+
+- name : Update webadmin settings
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ webadmin_settings :
+ vpnportal_https_port : 444
+ userportal_https_port : 4445
+ state : updated
+ delegate_to : localhost
+
+- name : Update loginsecurity settings
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ login_security :
+ logout_session : 120
+ block_login : Enable
+ unsuccessful_attempt : 3
+ duration : 30
+ minutes : 1
+ state : updated
+ delegate_to : localhost
+
+- name : Update administrator password complexity settings
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ password_complexity :
+ complexity_check : Enable
+ enforce_min_length : Enable
+ include_alpha : Enable
+ include_numeric : Enable
+ include_special : Enable
+ min_length : 10
+ state : updated
+ delegate_to : localhost
+
+- name : Update login disclaimer
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ login_disclaimer : Enable
+ state : updated
+ delegate_to : localhost
+
+- name : Query admin settings
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ state : query
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_atp_module.html b/sfos_atp_module.html
new file mode 100644
index 0000000..6aefe26
--- /dev/null
+++ b/sfos_atp_module.html
@@ -0,0 +1,375 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_atp module – Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_atp module – Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_atp module – Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_atp
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Enable (true) or disable (false) threat feeds
+
Choices:
+
+
+
hostname
+
string / required
+
+
inspect_content
+
string
+
Configure inspection of only untrusted or both trusted and untrusted content
+
Choices:
+
+
+
logging_policy
+
string
+
Configure logging policy
+
Choices:
+
+"Log only"
"Log and Drop"
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Update advanced threat protection settings
+ sophos.sophos_firewall.sfos_atp :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ inspect_content : untrusted
+ logging_policy : Log and Drop
+ state : updated
+ delegate_to : localhost
+
+- name : Query advanced threat protection settings
+ sophos.sophos_firewall.sfos_atp :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ state : query
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_backup_module.html b/sfos_backup_module.html
new file mode 100644
index 0000000..db1d16e
--- /dev/null
+++ b/sfos_backup_module.html
@@ -0,0 +1,450 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_backup module – Manage Backup settings (System > Backup & firmware) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_backup module – Manage Backup settings (System > Backup & firmware)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_backup module – Manage Backup settings (System > Backup & firmware)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_backup
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Day of month to be used when frequency is set to monthly
+
Day
+
Choices:
+
+"Monday"
"Tuesday"
"Wednesday"
"Thursday"
"Friday"
"Saturday"
"Sunday"
+
Email address to be used when using Email mode
+
+
encryption_password
+
string
+
Encryption password for the backup file. If this argument is specified, module will always return changed.
+
Backup frequency (Never/Daily/Weekly/Monthly)
+
Choices:
+
+"Never"
"Daily"
"Email"
+
FTP password. If this argument is specified, module will always return changed.
+
IP address of FTP server (hostname not currently allowed)
+
+
hostname
+
string / required
+
Backup mode (Local/FTP/Email)
+
Choices:
+
+"Local"
"FTP"
"Email"
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
Prefix for the backup file
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Update Backup Settings
+ sophos.sophos_firewall.sfos_backup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ mode : FTP
+ prefix : devfirewall
+ ftp_server : 10.10.10.1
+ ftp_username : ftpuser
+ ftp_password : ftppassword
+ ftp_path : home/backup
+ frequency : Weekly
+ day : Sunday
+ hour : 10
+ minute : 30
+ encryption_password : backupencryptionpassword
+ state : updated
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_device_access_profile_module.html b/sfos_device_access_profile_module.html
new file mode 100644
index 0000000..6cd7202
--- /dev/null
+++ b/sfos_device_access_profile_module.html
@@ -0,0 +1,1046 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_device_access_profile module – Manage Device Access Profiles (System > Profiles > Device Access) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_device_access_profile module – Manage Device Access Profiles (System > Profiles > Device Access)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_device_access_profile module – Manage Device Access Profiles (System > Profiles > Device Access)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_device_access_profile
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
application_filter
+
string
+
Application Filter permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
cloud_application_dashboard
+
string
+
Cloud Application Dashboard permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Dashboard permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
default_permission
+
string
+
Default permission to use for unspecified arguments when creating profile.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
email_protection
+
string
+
Email Protection permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Firewall permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
hostname
+
string / required
+
Identity permissions group.
+
+
authentication
+
string
+
Authentication permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
disconnect_live_user
+
string
+
Disconnect live user permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Groups permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
guest_user_management
+
string
+
Guest user management permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Policy permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
test_external_server_connectivity
+
string
+
Test external server connectivity permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
IPS permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
logs_reports
+
dictionary
+
Logs/Reports permissions group
+
Configuration permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
de_anonymization
+
string
+
De-anonymization permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
four_eye_authentication_settings
+
string
+
Four Eye authentication settings permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Log viewer permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
reports_access
+
string
+
Reports access permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
name
+
string / required
+
Network permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Objects permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
QoS permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
System permissions group.
+
Backup permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
central_management
+
string
+
Central Management permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
download_certificates
+
string
+
Restore permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Firmware permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
HA permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Licensing permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
other_certificate_configuration
+
string
+
Other certificate configuration permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Profile permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
reboot_shutdown
+
string
+
Reboot/Shutdown permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Restore permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Services permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
system_password
+
string
+
Manage system password
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Updates permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
traffic_discovery
+
string
+
Traffic Discovery permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
connect_tunnel
+
string
+
Connect tunnel permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
other_vpn_configurations
+
string
+
Other VPN configurations permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Alerts permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
other_waf_configuration
+
string
+
Other WAF configuration permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Web Filter permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
wireless_protection
+
dictionary
+
Wireless protection permissions group
+
+
wireless_protection_access_point
+
string
+
Wireless protection access point permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
wireless_protection_mesh
+
string
+
Wireless protection mesh permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
wireless_protection_network
+
string
+
Wireless protection network permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
wireless_protection_overview
+
string
+
Wireless protection overview permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
wireless_protection_settings
+
string
+
Wireless protection permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
Wizard permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
zero_day_protection
+
string
+
Zero day protection permissions.
+
Choices:
+
+"Read-Write"
"Read-Only"
"None"
+
+
+
+
+
+- name : CREATE A READ-ONLY PROFILE
+ sophos.sophos_firewall.sfos_device_access_profile :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : ReadOnlyAll
+ default_permission : Read-Only
+ state : present
+ delegate_to : localhost
+
+- name : CREATE A WIRELESS ADMIN PROFILE
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : WirelessAdmin
+ default_permission : Read-Only
+ wireless_protection :
+ wireless_protection_overview : Read-Write
+ wireless_protection_settings : Read-Write
+ wireless_protection_network : Read-Write
+ wireless_protection_access_point : Read-Write
+ wireless_protection_mesh : Read-Write
+ state : present
+ delegate_to : localhost
+
+- name : UPDATE PROFILE PERMISSIONS
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : ExampleProfile
+ system :
+ central_management : Read-Only
+ logs_reports :
+ log_viewer : Read-Write
+ reports_access : Read-Write
+ state : updated
+ delegate_to : localhost
+
+- name : RETRIEVE PROFILE
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : ExampleProfile
+ state : query
+ delegate_to : localhost
+
+- name : DELETE PROFILE
+ sophos.sophos_firewall.sfos_admin_settings :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : ExampleProfile
+ state : absent
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_dns_module.html b/sfos_dns_module.html
new file mode 100644
index 0000000..206b6e1
--- /dev/null
+++ b/sfos_dns_module.html
@@ -0,0 +1,428 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_dns module – Manage DNS settings (Configure > Network > DNS) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_dns module – Manage DNS settings (Configure > Network > DNS)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_firewall_rule_module.html b/sfos_firewall_rule_module.html
new file mode 100644
index 0000000..c84f199
--- /dev/null
+++ b/sfos_firewall_rule_module.html
@@ -0,0 +1,461 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_firewall_rule module – Manage Firewall Rules (Protect > Rules & policies) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_firewall_rule module – Manage Firewall Rules (Protect > Rules & policies)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_firewall_rule module – Manage Firewall Rules (Protect > Rules & policies)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_firewall_rule
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
action
+
string / required
+
The rule action.
+
Choices:
+
+"accept"
"drop"
"reject"
+
+
after_rulename
+
string
+
Name of the rule to insert this rule after.
+
+
before_rulename
+
string
+
Name of the rule to insert this rule before.
+
+
description
+
string / required
+
+
dst_networks
+
list / elements=string
+
Destination network(s).
+
+
dst_zones
+
list / elements=string / required
+
+
hostname
+
string / required
+
+
log
+
string / required
+
Enable or disable logging.
+
Choices:
+
+
+
name
+
string / required
+
Name of the firewall rule to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
Indicates where the rule should be inserted.
+
Choices:
+
+"top"
"bottom" ← (default)
"after"
"before"
+
+
services
+
list / elements=string
+
+
src_networks
+
list / elements=string / required
+
+
src_zones
+
list / elements=string / required
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
Enabled or Disabled state of the rule
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Create Firewall Rule
+ sophos.sophos_firewall.sfos_firewall_rule :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TEST RULE 100
+ after_rulename : TEST RULE 99
+ action : accept
+ description : Test rule created by Ansible
+ log : enable
+ status : enable
+ position : bottom
+ src_zones :
+ - LAN
+ dst_zones :
+ - WAN
+ src_networks :
+ - SRCNET1
+ - SRCNET2
+ dst_networks :
+ - DSTNET1
+ - DSTNET2
+ services :
+ - HTTPS
+ - SSH
+ state : present
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_fqdn_host_module.html b/sfos_fqdn_host_module.html
new file mode 100644
index 0000000..1e037a6
--- /dev/null
+++ b/sfos_fqdn_host_module.html
@@ -0,0 +1,383 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_fqdn_host module – Manage FQDN hosts (System > Hosts & services > FQDN host) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_fqdn_host module – Manage FQDN hosts (System > Hosts & services > FQDN host)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_fqdn_host module – Manage FQDN hosts (System > Hosts & services > FQDN host)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_fqdn_host
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Description for the FQDN.
+
+
fqdn_group_list
+
list / elements=string
+
A list of FQDN groups this FQDN host should be placed into when created. The sfos_fqdn_hostgroup module can be used to manage this post-creation.
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the FQDN object to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve FQDN Host
+ sophos.sophos_firewall.sfos_fqdn_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTFQDN
+ state : query
+ delegate_to : localhost
+
+- name : Create FQDN Host
+ sophos.sophos_firewall.sfos_fqdn_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTFQDN
+ description : Testing FQDN creation
+ fqdn : sophos.com
+ state : present
+ delegate_to : localhost
+
+- name : Add FQDN to FQDN Group
+ sophos.sophos_firewall.sfos_fqdn_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTFQDN
+ fqdn_group_list :
+ - TESTFQDNGROUP
+ state : updated
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_fqdn_hostgroup_module.html b/sfos_fqdn_hostgroup_module.html
new file mode 100644
index 0000000..728c23d
--- /dev/null
+++ b/sfos_fqdn_hostgroup_module.html
@@ -0,0 +1,394 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_fqdn_hostgroup module – Manage FQDN Host Groups (System > Hosts & services > FQDN host group) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_fqdn_hostgroup module – Manage FQDN Host Groups (System > Hosts & services > FQDN host group)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_fqdn_hostgroup module – Manage FQDN Host Groups (System > Hosts & services > FQDN host group)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_fqdn_hostgroup
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Indicates whether to add or remove hosts from the list, or replace the list entirely.
+
Choices:
+
+"add"
"remove"
"replace"
+
Description to be included on the FQDN Host Group object.
+
+
host_list
+
list / elements=string
+
List of FQDN Host objects to be included in the FQDN Hostgroup
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the FQDN Host Group object to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve FQDN Host Group
+ sophos.sophos_firewall.sfos_fqdn_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOSTGROUP
+ state : query
+ delegate_to : localhost
+
+- name : Create FQDN Host Group
+ sophos.sophos_firewall.sfos_fqdn_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTFQDNHOSTGROUP
+ description : Test FQDN Host Group
+ fqdn_host_list :
+ - TESTHOST1
+ - TESTHOST2
+ state : present
+ delegate_to : localhost
+
+- name : Add Hosts to FQDN Host Group
+ sophos.sophos_firewall.sfos_fqdn_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOSTGROUP
+ description : Test Host Group
+ fqdn_host_list :
+ - TESTHOST3
+ - TESTHOST4
+ action : add
+ state : updated
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_ip_host_module.html b/sfos_ip_host_module.html
new file mode 100644
index 0000000..e167d38
--- /dev/null
+++ b/sfos_ip_host_module.html
@@ -0,0 +1,413 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_ip_host module – Manage IP Host (System > Hosts & services > IP host) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_ip_host module – Manage IP Host (System > Hosts & services > IP host)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_ip_host module – Manage IP Host (System > Hosts & services > IP host)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_ip_host
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Ending IP address for use when creating an IP range.
+
Type of IP Host object.
+
Choices:
+
+"ip" ← (default)
"network"
"range"
+
+
hostname
+
string / required
+
IP Address for use when creating an IP address.
+
Network mask for use when creating an IP network.
+
+
name
+
string / required
+
Name of the IP Host object to create, update, or delete
+
Network address for use when creating an IP network.
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
Starting IP address for use when an creating IP range.
+
+
state
+
string / required
+
Use present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Create IP Host
+ sophos.sophos_firewall.sfos_ip_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOST
+ ip_address : 1.1.1.1
+ state : present
+ delegate_to : localhost
+
+- name : Create IP Network
+ sophos.sophos_firewall.sfos_ip_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTNETWORK
+ network : 1.1.1.0
+ mask : 255.255.255.0
+ host_type : network
+ state : present
+ delegate_to : localhost
+
+- name : Create IP Range
+ sophos.sophos_firewall.sfos_ip_host :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTRANGE
+ start_ip : 10.1.1.1
+ end_ip : 10.1.1.2
+ host_type : range
+ state : present
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_ip_hostgroup_module.html b/sfos_ip_hostgroup_module.html
new file mode 100644
index 0000000..36ad708
--- /dev/null
+++ b/sfos_ip_hostgroup_module.html
@@ -0,0 +1,394 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_ip_hostgroup module – Manage IP Hostgroup (System > Hosts & services > IP host group) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_ip_hostgroup module – Manage IP Hostgroup (System > Hosts & services > IP host group)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_ip_hostgroup module – Manage IP Hostgroup (System > Hosts & services > IP host group)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_ip_hostgroup
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Indicates whether to add or remove hosts from the list, or replace the list entirely.
+
Choices:
+
+"add"
"remove"
"replace"
+
Description to be included on the IP Host Group object.
+
+
host_list
+
list / elements=string
+
List of IP Host objects to be included in the IP Hostgroup
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the IP Host Group object to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve IP Host Group
+ sophos.sophos_firewall.sfos_ip_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOSTGROUP
+ state : query
+ delegate_to : localhost
+
+- name : Create IP Host Group
+ sophos.sophos_firewall.sfos_ip_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOSTGROUP
+ description : Test Host Group
+ host_list :
+ - TESTHOST1
+ - TESTHOST2
+ state : present
+ delegate_to : localhost
+
+- name : Add Hosts to IP Host Group
+ sophos.sophos_firewall.sfos_ip_hostgroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTHOSTGROUP
+ description : Test Host Group
+ host_list :
+ - TESTHOST3
+ - TESTHOST4
+ action : add
+ state : updated
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_ips_module.html b/sfos_ips_module.html
new file mode 100644
index 0000000..0afc408
--- /dev/null
+++ b/sfos_ips_module.html
@@ -0,0 +1,349 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_ips module – Manage IPS protection (Protect > Intrusion Protection > IPS policies) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_ips module – Manage IPS protection (Protect > Intrusion Protection > IPS policies)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_ips module – Manage IPS protection (Protect > Intrusion Protection > IPS policies)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_ips
+
New in sophos.sophos_firewall 1.2.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Enable (true) or disable (false) IPS protection
+
Choices:
+
+
+
hostname
+
string / required
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Enable IPS protection
+ sophos.sophos_firewall.sfos_ips :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ state : updated
+ delegate_to : localhost
+
+- name : Query IPS protection settings
+ sophos.sophos_firewall.sfos_ips :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ state : query
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_malware_protection_module.html b/sfos_malware_protection_module.html
new file mode 100644
index 0000000..a9f687f
--- /dev/null
+++ b/sfos_malware_protection_module.html
@@ -0,0 +1,349 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_malware_protection module – Manage Malware Protection (Configure > System services > Malware protection) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_malware_protection module – Manage Malware Protection (Configure > System services > Malware protection)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_service_acl_exception_module.html b/sfos_service_acl_exception_module.html
new file mode 100644
index 0000000..ede2682
--- /dev/null
+++ b/sfos_service_acl_exception_module.html
@@ -0,0 +1,429 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_service_acl_exception module – Manage Local Service Exception ACL Rules (System > Administration > Device Access) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_service_acl_exception module – Manage Local Service Exception ACL Rules (System > Administration > Device Access)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_service_acl_exception module – Manage Local Service Exception ACL Rules (System > Administration > Device Access)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_service_acl_exception
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Accept or Drop.
+
Choices:
+
+
Description of the Local service ACL exception rule.
+
+
dest_list
+
list / elements=string
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the Local service ACL exception rule to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
Position of the rule (Top or Bottom).
+
Choices:
+
+"top"
"bottom" ← (default)
+
+
service_list
+
list / elements=string
+
+
source_list
+
list / elements=string
+
Source Network(s) or Host(s).
+
Source zone of the Local service ACL exception rule.
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
Indicate whether entries specified for source_list, dest_list, or service_list should be added or removed from, or replaced when updating.
+
Choices:
+
+"add" ← (default)
"remove"
"replace"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve Local service ACL exception rule
+ sophos.sophos_firewall.sfos_service_acl_exception :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTACLRULE
+ state : query
+
+- name : Create Local service ACL exception rule
+ sophos.sophos_firewall.sfos_service_acl_exception :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTACLRULE
+ description : Test ACL Rule
+ position : bottom
+ source_zone : LAN
+ source_list :
+ - TESTHOST1
+ - TESTHOST2
+ dest_list :
+ - TESTHOST3
+ service_list :
+ - HTTP
+ - HTTPS
+ action : drop
+ state : present
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_service_module.html b/sfos_service_module.html
new file mode 100644
index 0000000..79582ac
--- /dev/null
+++ b/sfos_service_module.html
@@ -0,0 +1,456 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_service module – Manage Service (System > Hosts and services > Services) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_service module – Manage Service (System > Hosts and services > Services)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_service module – Manage Service (System > Hosts and services > Services)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_service
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+When performing an update, use to add or remove services from the list, or replace the list entirely
+
Choices:
+
+"add"
"remove"
"replace" ← (default)
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the Service object to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
service_list
+
list / elements=dictionary
+
A list of ports/protocols to be included in the service definition.
+
Destination TCP or UDP port.
+
ICMP code in numeric format.
+
ICMP type in numeric format.
+
TCP, UDP, or IP protocol number
+
Source TCP or UDP port.
+
Default: "1:65535"
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
Type of service object.
+
Choices:
+
+"tcporudp"
"ip"
"icmp"
"icmpv6"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve Service
+ sophos.sophos_firewall.sfos_service :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICE
+ state : query
+ delegate_to : localhost
+
+- name : Create Service
+ sophos.sophos_firewall.sfos_service :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICEWEB
+ type : tcporudp
+ service_list :
+ - protocol : tcp
+ src_port : 1:65535
+ dst_port : 80
+ - protocol : tcp
+ src_port : 1:65535
+ dst_port : 443
+ state : present
+ delegate_to : localhost
+
+- name : Add service to service list
+ sophos.sophos_firewall.sfos_service :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICEWEB
+ service_list :
+ - protocol : tcp
+ src_port : 1:65535
+ dst_port : 8888
+ action : add
+ state : updated
+ delegate_to : localhost
+
+- name : Add ICMP service
+ sophos.sophos_firewall.sfos_service :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTICMP
+ type : icmp
+ service_list :
+ - icmp_type : "Echo Reply"
+ icmp_code : "Any Code"
+ state : present
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_servicegroup_module.html b/sfos_servicegroup_module.html
new file mode 100644
index 0000000..c27ca3a
--- /dev/null
+++ b/sfos_servicegroup_module.html
@@ -0,0 +1,381 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_servicegroup module – Manage Service Group (System > Hosts and services > Service Group) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_servicegroup module – Manage Service Group (System > Hosts and services > Service Group)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_servicegroup module – Manage Service Group (System > Hosts and services > Service Group)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_servicegroup
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+Description to be included on the Service Group object.
+
+
hostname
+
string / required
+
+
name
+
string / required
+
Name of the Service Group object to create, update, or delete
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
service_list
+
list / elements=string
+
List of Service objects to be included in the Servicegroup
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Retrieve Service Group
+ sophos.sophos_firewall.sfos_servicegroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICEGROUP
+ state : query
+ delegate_to : localservice
+
+- name : Create Service Group
+ sophos.sophos_firewall.sfos_servicegroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICEGROUP
+ description : Test Service Group
+ service_list :
+ - HTTP
+ - HTTPS
+ state : present
+ delegate_to : localservice
+
+- name : Add Services to Service Group
+ sophos.sophos_firewall.sfos_servicegroup :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : myfirewallhostname.sophos.net
+ port : 4444
+ verify : false
+ name : TESTSERVICEGROUP
+ description : Test Host Group
+ service_list :
+ - TESTSERVICE3
+ - TESTSERVICE4
+ action : add
+ state : updated
+ delegate_to : localservice
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_snmp_agent_module.html b/sfos_snmp_agent_module.html
new file mode 100644
index 0000000..4e47e9d
--- /dev/null
+++ b/sfos_snmp_agent_module.html
@@ -0,0 +1,381 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_snmp_agent module – Manage SNMP Agent (System > Administration > SNMP) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_snmp_agent module – Manage SNMP Agent (System > Administration > SNMP)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_snmp_agent module – Manage SNMP Agent (System > Administration > SNMP)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_snmp_agent
+
New in sophos.sophos_firewall 1.1.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
contact_person
+
string
+
Description assigned to SNMP agent
+
Enable (true) or disable (false) threat feeds
+
Choices:
+
+
+
hostname
+
string / required
+
Identifying name of firewall
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Update SNMP agent configuration
+ sophos.sophos_firewall.sfos_snmp_agent :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ name : testfirewall
+ description : Firewall used for automation testing
+ location : AWS
+ contact_person : Network Operations
+ state : updated
+ delegate_to : localhost
+
+- name : Query advanced threat protection settings
+ sophos.sophos_firewall.sfos_snmp_agent :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ state : query
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_snmp_user_module.html b/sfos_snmp_user_module.html
new file mode 100644
index 0000000..66cf4f0
--- /dev/null
+++ b/sfos_snmp_user_module.html
@@ -0,0 +1,454 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_snmp_user module – Manage SNMPv3 User (System > Administration > SNMP) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_snmp_user module – Manage SNMPv3 User (System > Administration > SNMP)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_snmp_user module – Manage SNMPv3 User (System > Administration > SNMP)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_snmp_user
+
New in sophos.sophos_firewall 1.1.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
accept_queries
+
string
+
Enable or Disable querying
+
Choices:
+
+
+
authentication_algorithm
+
string
+
Authentication algorithm
+
Choices:
+
+"MD5"
"SHA256"
"SHA512"
+
+
authentication_password
+
string
+
Authentication password
+
+
authorized_hosts
+
list / elements=string
+
List of authorized hosts
+
+
encryption_algorithm
+
string
+
Encryption algorithm
+
Choices:
+
+
+
encryption_password
+
string
+
+
hostname
+
string / required
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
Enable or Disable sending of SNMP traps
+
Choices:
+
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Add SNMPv3 User
+ sophos.sophos_firewall.sfos_snmp_user :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ name : snmpv3user
+ send_queries : Enable
+ send_traps : Disable
+ authorized_hosts :
+ - 10.100.1.104
+ - 10.100.1.105
+ encryption_algorithm : AES
+ encryption_password : " {{ encryption_password }} "
+ authentication_algorithm : MD5
+ authentication_password : " {{ authentication_password }} "
+ state : present
+ delegate_to : localhost
+
+- name : Query SNMPv3 User
+ sophos.sophos_firewall.sfos_snmp_user :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : snmpv3user
+ state : query
+ delegate_to : localhost
+
+- name : Update SNMPv3 User
+ sophos.sophos_firewall.sfos_snmp_user :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ name : snmpv3user
+ send_queries : Disable
+ encryption_algorithm : AES
+ encryption_password : " {{ encryption_password }} "
+ authentication_password : " {{ authentication_password }} "
+ state : present
+ delegate_to : localhost
+
+- name : Remove SNMPv3 User
+ sophos.sophos_firewall.sfos_snmp_user :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ enabled : true
+ name : snmpv3user
+ state : absent
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_syslog_module.html b/sfos_syslog_module.html
new file mode 100644
index 0000000..c59d628
--- /dev/null
+++ b/sfos_syslog_module.html
@@ -0,0 +1,1135 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_syslog module – Manage Syslog servers (Configure > System services > Log settings) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_syslog module – Manage Syslog servers (Configure > System services > Log settings)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_time_module.html b/sfos_time_module.html
new file mode 100644
index 0000000..2c32bfd
--- /dev/null
+++ b/sfos_time_module.html
@@ -0,0 +1,398 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_time module – Manage Date and Time settings (System > Administration > Time) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_time module – Manage Date and Time settings (System > Administration > Time)
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_time module – Manage Date and Time settings (System > Administration > Time)
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_time
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+
+
hostname
+
string / required
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query updated
+
Choices:
+
+
Timezone setting. WARNING: WILL CAUSE DEVICE REBOOT!
+
+
username
+
string / required
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+- name : Update Time Settings
+ sophos.sophos_firewall.sfos_time :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ timezone : Europe/London
+ date :
+ year : 2024
+ month : 9
+ day : 26
+ time :
+ hour : 10
+ minute : 28
+ second : 59
+ state : updated
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_user_module.html b/sfos_user_module.html
new file mode 100644
index 0000000..d30fb8f
--- /dev/null
+++ b/sfos_user_module.html
@@ -0,0 +1,535 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_user module – Manage Users (Configure > Authentication > Users) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_user module – Manage Users (Configure > Authentication > Users)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_xmlapi_module.html b/sfos_xmlapi_module.html
new file mode 100644
index 0000000..361c927
--- /dev/null
+++ b/sfos_xmlapi_module.html
@@ -0,0 +1,426 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_xmlapi module – Use the XML API to get, create, update, or delete settings on Sophos Firewall. — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_xmlapi module – Use the XML API to get, create, update, or delete settings on Sophos Firewall.
+
+
+
+
+
+
+
+
+
+
+
+sophos.sophos_firewall.sfos_xmlapi module – Use the XML API to get, create, update, or delete settings on Sophos Firewall.
+
+
Note
+
This module is part of the sophos.sophos_firewall collection (version 1.2.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it, use: ansible-galaxy collection install sophos.sophos_firewall Requirements
+
To use it in a playbook, specify: sophos.sophos_firewall.sfos_xmlapi
+
New in sophos.sophos_firewall 1.0.0
+
+
+
+
+
+The below requirements are needed on the host that executes this module.
+
+
+
+
+
+
+Parameter
Comments
+
+XML payload data for use with the present (add) or updated (update) state.
+
+
hostname
+
string / required
+
Optional search key when using the query option.
+
+
name
+
string / required
+
Name of an object to retrieve when using query option, or to delete when using absent.
+
Optional search operator when using the query option.
+
Choices:
+
+
+
password
+
string / required
+
Firewall HTTP Port
+
Default: 4444
+
+
state
+
string / required
+
Use query present absent updated
+
Choices:
+
+"present"
"absent"
"updated"
"query"
+
+
username
+
string / required
+
Optional search value when using the query option.
+
Perform certificate verification
+
Choices:
+
+false
true ← (default)
+
+
xml_tag
+
string / required
+
The XML tag for the lookup when using the query option, or the top-level tag when creating/updating.
+
+
+
+
+
+- name : CREATE MAC HOST
+ sophos.sophos_firewall.sfos_xmlapi :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ xml_tag : MACHost
+ data : |
+ <MACHost>
+ <Name>TESTMACHOST1</Name>
+ <Description>Created by Ansible xmlapi module</Description>
+ <Type>MACAddress</Type>
+ <MACAddress>00:16:76:49:33:FF</MACAddress>
+ </MACHost>
+ state : present
+ delegate_to : localhost
+
+- name : UPDATE MAC HOST
+ sophos.sophos_firewall.sfos_xmlapi :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ xml_tag : MACHost
+ data : |
+ <MACHost>
+ <Name>TESTMACHOST1</Name>
+ <Description>UPDATED by Ansible xmlapi module</Description>
+ <Type>MACAddress</Type>
+ <MACAddress>00:16:76:49:01:01</MACAddress>
+ </MACHost>
+ state : updated
+ delegate_to : localhost
+
+- name : GET MAC HOST
+ sophos.sophos_firewall.sfos_xmlapi :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ xml_tag : MACHost
+ name : TESTMACHOST1
+ state : query
+ delegate_to : localhost
+
+- name : REMOVE MAC HOST
+ sophos.sophos_firewall.sfos_xmlapi :
+ username : " {{ username }} "
+ password : " {{ password }} "
+ hostname : " {{ inventory_hostname }} "
+ port : 4444
+ verify : false
+ name : TESTMACHOST1
+ xml_tag : MACHost
+ state : absent
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+
+
api_response
+
dictionary
+
Serialized object containing the API response.
+
Returned: always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sfos_zone_module.html b/sfos_zone_module.html
new file mode 100644
index 0000000..1306f47
--- /dev/null
+++ b/sfos_zone_module.html
@@ -0,0 +1,614 @@
+
+
+
+
+
+
+
+
+
+
sophos.sophos_firewall.sfos_zone module – Manage Zones (Configure > Network > Zones) — Sophos Firewall documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sophos Firewall Ansible Collection
+
+
+
+
+
+
+
+ Sophos Firewall
+
+
+
+
+
+
+ sophos.sophos_firewall.sfos_zone module – Manage Zones (Configure > Network > Zones)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
+ 
+ 
+