diff options
98 files changed, 20553 insertions, 1695 deletions
diff --git a/.github/styles/Google/AMPM.yml b/.github/styles/Google/AMPM.yml deleted file mode 100644 index fbdc6e4f..00000000 --- a/.github/styles/Google/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'AM' or 'PM' (preceded by a space)." -link: 'https://developers.google.com/style/word-list' -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.github/styles/Google/Acronyms.yml b/.github/styles/Google/Acronyms.yml deleted file mode 100644 index f41af018..00000000 --- a/.github/styles/Google/Acronyms.yml +++ /dev/null @@ -1,64 +0,0 @@ -extends: conditional -message: "Spell out '%s', if it's unfamiliar to the audience." -link: 'https://developers.google.com/style/abbreviations' -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP diff --git a/.github/styles/Google/Colons.yml b/.github/styles/Google/Colons.yml deleted file mode 100644 index 9a4b4b4a..00000000 --- a/.github/styles/Google/Colons.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "'%s' should be in lowercase." -link: 'https://developers.google.com/style/colons' -nonword: true -level: warning -tokens: - - ':\s[A-Z]' diff --git a/.github/styles/Google/Contractions.yml b/.github/styles/Google/Contractions.yml deleted file mode 100644 index 905a39f4..00000000 --- a/.github/styles/Google/Contractions.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: substitution -message: "Feel free to use '%s' instead of '%s'." -link: 'https://developers.google.com/style/contractions' -level: suggestion -ignorecase: true -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - it is: it's - should not: shouldn't - that is: that's - they are: they're - was not: wasn't - we are: we're - we have: we've - were not: weren't - what is: what's - when is: when's - where is: where's - will not: won't diff --git a/.github/styles/Google/DateFormat.yml b/.github/styles/Google/DateFormat.yml deleted file mode 100644 index e9d227fa..00000000 --- a/.github/styles/Google/DateFormat.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'July 31, 2016' format, not '%s'." -link: 'https://developers.google.com/style/dates-times' -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.github/styles/Google/Ellipses.yml b/.github/styles/Google/Ellipses.yml deleted file mode 100644 index 436e6177..00000000 --- a/.github/styles/Google/Ellipses.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: 'https://developers.google.com/style/ellipses' -nonword: true -level: warning -tokens: - - '\.\.\.' diff --git a/.github/styles/Google/EmDash.yml b/.github/styles/Google/EmDash.yml deleted file mode 100644 index c6018db1..00000000 --- a/.github/styles/Google/EmDash.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't put a space before or after an em dash." -link: 'https://developers.google.com/style/dashes' -nonword: true -level: error -tokens: - - '\s—' - - '—\s' diff --git a/.github/styles/Google/EnDash.yml b/.github/styles/Google/EnDash.yml deleted file mode 100644 index 194876aa..00000000 --- a/.github/styles/Google/EnDash.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use an em dash ('—') instead of '–'." -link: 'https://developers.google.com/style/dashes' -nonword: true -level: error -tokens: - - '–' diff --git a/.github/styles/Google/Exclamation.yml b/.github/styles/Google/Exclamation.yml deleted file mode 100644 index c4db380b..00000000 --- a/.github/styles/Google/Exclamation.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use exclamation points in text." -link: 'https://developers.google.com/style/exclamation-points' -nonword: true -level: error -tokens: - - '!' diff --git a/.github/styles/Google/FirstPerson.yml b/.github/styles/Google/FirstPerson.yml deleted file mode 100644 index d2290611..00000000 --- a/.github/styles/Google/FirstPerson.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Avoid first-person pronouns such as '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - \bme\b - - \bus\b - - \bours\b diff --git a/.github/styles/Google/Gender.yml b/.github/styles/Google/Gender.yml deleted file mode 100644 index c8486181..00000000 --- a/.github/styles/Google/Gender.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Don't use '%s' as a gender-neutral pronoun." -link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' -level: error -ignorecase: true -tokens: - - he/she - - s/he - - \(s\)he diff --git a/.github/styles/Google/GenderBias.yml b/.github/styles/Google/GenderBias.yml deleted file mode 100644 index 261cfb66..00000000 --- a/.github/styles/Google/GenderBias.yml +++ /dev/null @@ -1,45 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: 'https://developers.google.com/style/inclusive-documentation' -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.github/styles/Google/HeadingPunctuation.yml b/.github/styles/Google/HeadingPunctuation.yml deleted file mode 100644 index 5c39abbf..00000000 --- a/.github/styles/Google/HeadingPunctuation.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't put a period at the end of a heading." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -nonword: true -level: warning -scope: heading -tokens: - - '[a-z0-9][.](?:\s|$)' diff --git a/.github/styles/Google/Headings.yml b/.github/styles/Google/Headings.yml deleted file mode 100644 index 5afb968d..00000000 --- a/.github/styles/Google/Headings.yml +++ /dev/null @@ -1,26 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -level: warning -scope: heading -match: $sentence -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/.github/styles/Google/Hyphens.yml b/.github/styles/Google/Hyphens.yml deleted file mode 100644 index f9779637..00000000 --- a/.github/styles/Google/Hyphens.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't place a space on either side of a hyphen (unless it's suspended)." -link: 'https://developers.google.com/style/hyphens' -level: warning -nonword: true -tokens: - - '\s-' - - '-\s' diff --git a/.github/styles/Google/Latin.yml b/.github/styles/Google/Latin.yml deleted file mode 100644 index f032b349..00000000 --- a/.github/styles/Google/Latin.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -nonword: true -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is diff --git a/.github/styles/Google/LyHyphens.yml b/.github/styles/Google/LyHyphens.yml deleted file mode 100644 index d5b6a942..00000000 --- a/.github/styles/Google/LyHyphens.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: 'https://developers.google.com/style/hyphens' -level: error -ignorecase: false -nonword: true -tokens: - - '\s[^\s-]+ly-' diff --git a/.github/styles/Google/OptionalPlurals.yml b/.github/styles/Google/OptionalPlurals.yml deleted file mode 100644 index 7058932f..00000000 --- a/.github/styles/Google/OptionalPlurals.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use plurals in parentheses such as in '%s'." -link: 'https://developers.google.com/style/plurals-parentheses' -level: error -nonword: true -tokens: - - '\b\w+\(s\)' diff --git a/.github/styles/Google/Ordinal.yml b/.github/styles/Google/Ordinal.yml deleted file mode 100644 index 8c429e0f..00000000 --- a/.github/styles/Google/Ordinal.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Spell out all ordinal numbers ('%s') in text." -link: 'https://developers.google.com/style/numbers' -level: error -nonword: true -tokens: - - \d+(?:st|th|rd) diff --git a/.github/styles/Google/OxfordComma.yml b/.github/styles/Google/OxfordComma.yml deleted file mode 100644 index 98b07113..00000000 --- a/.github/styles/Google/OxfordComma.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: 'https://developers.google.com/style/commas' -scope: sentence -level: warning -tokens: - - '(?:[^,]+,){1,}\s\w+\sand' diff --git a/.github/styles/Google/Parens.yml b/.github/styles/Google/Parens.yml deleted file mode 100644 index 3b8711d0..00000000 --- a/.github/styles/Google/Parens.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use parentheses judiciously." -link: 'https://developers.google.com/style/parentheses' -nonword: true -level: suggestion -tokens: - - '\(.+\)' diff --git a/.github/styles/Google/Passive.yml b/.github/styles/Google/Passive.yml deleted file mode 100644 index 3265890e..00000000 --- a/.github/styles/Google/Passive.yml +++ /dev/null @@ -1,184 +0,0 @@ -extends: existence -link: 'https://developers.google.com/style/voice' -message: "In general, use active voice instead of passive voice ('%s')." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/.github/styles/Google/Periods.yml b/.github/styles/Google/Periods.yml deleted file mode 100644 index d24a6a6c..00000000 --- a/.github/styles/Google/Periods.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use periods with acronyms or initialisms such as '%s'." -link: 'https://developers.google.com/style/abbreviations' -level: error -nonword: true -tokens: - - '\b(?:[A-Z]\.){3,}' diff --git a/.github/styles/Google/Quotes.yml b/.github/styles/Google/Quotes.yml deleted file mode 100644 index 3cb6f1ab..00000000 --- a/.github/styles/Google/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Commas and periods go inside quotation marks." -link: 'https://developers.google.com/style/quotation-marks' -level: error -nonword: true -tokens: - - '"[^"]+"[.,?]' diff --git a/.github/styles/Google/Ranges.yml b/.github/styles/Google/Ranges.yml deleted file mode 100644 index 3ec045e7..00000000 --- a/.github/styles/Google/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't add words such as 'from' or 'between' to describe a range of numbers." -link: 'https://developers.google.com/style/hyphens' -nonword: true -level: warning -tokens: - - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/.github/styles/Google/Semicolons.yml b/.github/styles/Google/Semicolons.yml deleted file mode 100644 index bb8b85b4..00000000 --- a/.github/styles/Google/Semicolons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use semicolons judiciously." -link: 'https://developers.google.com/style/semicolons' -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/.github/styles/Google/Slang.yml b/.github/styles/Google/Slang.yml deleted file mode 100644 index 63f4c248..00000000 --- a/.github/styles/Google/Slang.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Don't use internet slang abbreviations such as '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -tokens: - - 'tl;dr' - - ymmv - - rtfm - - imo - - fwiw diff --git a/.github/styles/Google/Spacing.yml b/.github/styles/Google/Spacing.yml deleted file mode 100644 index 5f209a9f..00000000 --- a/.github/styles/Google/Spacing.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: 'https://developers.google.com/style/sentence-spacing' -level: error -nonword: true -tokens: - - '[.?!] {2,}[A-Z]' - - '[.?!][A-Z]' diff --git a/.github/styles/Google/Spelling.yml b/.github/styles/Google/Spelling.yml deleted file mode 100644 index 57acb884..00000000 --- a/.github/styles/Google/Spelling.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "In general, use American spelling instead of '%s'." -link: 'https://developers.google.com/style/spelling' -ignorecase: true -level: warning -tokens: - - '(?:\w+)nised?' - - '(?:\w+)logue' diff --git a/.github/styles/Google/Units.yml b/.github/styles/Google/Units.yml deleted file mode 100644 index 220de3e9..00000000 --- a/.github/styles/Google/Units.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Put a nonbreaking space between the number and the unit in '%s'." -link: 'https://developers.google.com/style/units-of-measure' -nonword: true -level: error -tokens: - - \d+(?:GB|TB|MB) diff --git a/.github/styles/Google/Will.yml b/.github/styles/Google/Will.yml deleted file mode 100644 index 128a9183..00000000 --- a/.github/styles/Google/Will.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Avoid using '%s'." -link: 'https://developers.google.com/style/tense' -ignorecase: true -level: warning -tokens: - - will diff --git a/.github/styles/Google/WordList.yml b/.github/styles/Google/WordList.yml deleted file mode 100644 index d5d6bea5..00000000 --- a/.github/styles/Google/WordList.yml +++ /dev/null @@ -1,79 +0,0 @@ -extends: substitution -message: "Use %s instead of '%s'." -link: 'https://developers.google.com/style/word-list' -level: warning -ignorecase: false -swap: - '(?:API Console|dev|developer) key': "'API key'" - '(?:cell ?phone|smart ?phone)': "'phone' or 'mobile phone'" - '(?:dev|developer|APIs) console': "'API console'" - '(?:e-mail|Email|E-mail)': "'email'" - '(?:file ?path|path ?name)': "'path'" - '(?:kill|terminate)': "'stop', 'exit', 'cancel', or 'end'" - '(?:OAuth ?2|Oauth)': "'OAuth 2.0'" - '(?:ok|Okay)': "'OK' or 'okay'" - '(?:WiFi|wifi)': "'Wi-Fi'" - '[\.]+apk': "'APK'" - '3\-D': "'3D'" - 'Google (?:I\-O|IO)': "'Google I/O'" - 'tap (?:&|and) hold': "'touch & hold'" - 'un(?:check|select)': "'clear'" - abort: "'stop', 'exit', 'cancel' or 'end'" - above: "'preceding'" - account name: "'username'" - action bar: "'app bar'" - admin: "'administrator'" - Ajax: "'AJAX'" - Android device: "'Android-powered device'" - android: "'Android'" - API explorer: "'APIs Explorer'" - application: "'app'" - approx\.: "'approximately'" - authN: "'authentication'" - authZ: "'authorization'" - autoupdate: "'automatically update'" - cellular data: "'mobile data'" - cellular network: "'mobile network'" - chapter: "'documents', 'pages', 'sections'" - check box: "'checkbox'" - check: "'select'" - CLI: "'command-line tool'" - click on: "'click' or 'click in'" - Cloud: "'Google Cloud Platform' or 'GCP'" - Container Engine: "'Kubernetes Engine'" - content type: "'media type'" - curated roles: "'predefined roles'" - data are: "'data is'" - Developers Console: "'Google API Console' or 'API Console'" - disabled?: "'turn off' or 'off'" - ephemeral IP address: "'ephemeral external IP address'" - fewer data: "'less data'" - file name: "'filename'" - firewalls: "'firewall rules'" - functionality: "'capability' or 'feature'" - Google account: "'Google Account'" - Google accounts: "'Google Accounts'" - Googling: "'search with Google'" - grayed-out: "'unavailable'" - HTTPs: "'HTTPS'" - in order to: "'to'" - ingest: "'import' or 'load'" - k8s: "'Kubernetes'" - long press: "'touch & hold'" - network IP address: "'internal IP address'" - omnibox: "'address bar'" - open-source: "'open source'" - overview screen: "'recents screen'" - regex: "'regular expression'" - SHA1: "'SHA-1' or 'HAS-SHA1'" - sign into: "'sign in to'" - sign-?on: "'single sign-on'" - static IP address: "'static external IP address'" - stylesheet: "'style sheet'" - synch: "'sync'" - tablename: "'table name'" - tablet: "'device'" - touch: "'tap'" - url: "'URL'" - vs\.: "'versus'" - World Wide Web: "'web'" diff --git a/.github/styles/Google/meta.json b/.github/styles/Google/meta.json deleted file mode 100644 index 3ae5fb21..00000000 --- a/.github/styles/Google/meta.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "author": "Joseph Kato", - "description": "A Vale-compatible implementation of the Microsoft Writing Style Guide.", - "email": "support@errata.ai", - "lang": "en", - "url": "https://github.com/errata-ai/Google/releases/latest/download/Google.zip", - "feed": "https://github.com/errata-ai/Google/releases.atom", - "issues": "https://github.com/errata-ai/Google/issues/new", - "license": "MIT", - "name": "Google", - "sources": [ - "https://developers.google.com/style/" - ], - "vale_version": ">=1.0.0", - "coverage": 0.0 -} diff --git a/.github/styles/Google/vocab.txt b/.github/styles/Google/vocab.txt deleted file mode 100644 index e69de29b..00000000 --- a/.github/styles/Google/vocab.txt +++ /dev/null diff --git a/.github/styles/VyOS/Terminology.yml b/.github/styles/VyOS/Terminology.yml deleted file mode 100644 index cd0c5089..00000000 --- a/.github/styles/VyOS/Terminology.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: substitution -message: Prefer '%s' over '%s' -ignorecase: false -level: error -swap: - vyos: VyOS - Vyos: VyOS - VYOS: VyOS - Gre: GRE
\ No newline at end of file @@ -9,6 +9,7 @@ docutils = "*" lxml = "*" sphinx-notfound-page = "*" Sphinx = ">=1.4.3" +sphinx-panels = "*" [dev-packages] @@ -6,7 +6,7 @@ Our old WiKi can still be accessed from the # Build -[](https://docs.vyos.io/en/latest/?badge=latest) +[](https://docs.vyos.io/en/latest/?badge=equuleus) # Versions @@ -28,20 +28,6 @@ largest. There are 88 of them, here's the * 1.4.x: `sagitta` (Arrow) * ... -## Native - -To build the manual, run the following commands inside the `docs` folder: - -* `make html` for an HTML manual -* `make latexpdf` for a LaTeX rendered PDF - -Required Debian Packages: -* `latexmk` -* `texlive-latex-recommended` -* `texlive-fonts-recommended` -* `texlive-latex-extra` -* `sphinx` - ### sphinx Debian requires some extra steps for installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages: @@ -76,7 +62,6 @@ Then run: sudo pip install sphinx-rtd-theme ``` - Do the following to build the HTML and start a webserver: * Run `make livehtml` inside the `docs` folder diff --git a/docker/Dockerfile b/docker/Dockerfile index 903a8e83..9b3195df 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -34,6 +34,8 @@ RUN pip3 install sphinx-rtd-theme RUN pip3 install sphinx-autobuild RUN pip3 install sphinx-notfound-page RUN pip3 install lxml +RUN pip3 install myst-parser +RUN pip3 install sphinx-panels # Cleanup @@ -45,8 +47,6 @@ EXPOSE 8000 RUN sed "s/^%sudo.*/%sudo\tALL=(ALL) NOPASSWD:ALL/g" -i /etc/sudoers && \ chmod a+s /usr/sbin/useradd /usr/sbin/groupadd /usr/sbin/gosu /usr/sbin/usermod -# vale -RUN curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s v1.7.1 COPY entrypoint.sh /usr/local/bin/entrypoint.sh diff --git a/docs/404.rst b/docs/404.rst index 85444615..dd2c5d13 100644 --- a/docs/404.rst +++ b/docs/404.rst @@ -7,4 +7,5 @@ Sorry, We could not find a page. Try using the search box or go to the release homepage: * `1.2.x (crux) <https://docs.vyos.io/en/crux/>`_ + * `1.3.x (crux) <https://docs.vyos.io/en/equuleus/>`_ * `rolling release (equuleus) <https://docs.vyos.io/en/latest/>`_
\ No newline at end of file diff --git a/docs/_ext/testcoverage.py b/docs/_ext/testcoverage.py index 90d9a93e..3d1461a9 100644 --- a/docs/_ext/testcoverage.py +++ b/docs/_ext/testcoverage.py @@ -337,7 +337,8 @@ def get_working_commands(): } for kind in config_tree_new: for e in config_tree_new[kind]: - result[kind].extend(create_commands(config_tree_new[kind][e])) + if config_tree_new[kind][e]['name']: + result[kind].extend(create_commands(config_tree_new[kind][e])) for cmd in result['cfgcmd']: cmd['cmd'] = " ".join(cmd['name']) diff --git a/docs/_ext/vyos.py b/docs/_ext/vyos.py index 0a198821..fbdfefab 100644 --- a/docs/_ext/vyos.py +++ b/docs/_ext/vyos.py @@ -437,20 +437,45 @@ class CfgCmdDirective(CmdDirective): def strip_cmd(cmd, debug=False): + + # find all [...] and also nested [...] + # regex and str.find() had problems with nested [...] + appearance = 0 + cmd_new = "" + for c in cmd: + if c == "[": + appearance = appearance + 1 + if appearance == 0: + cmd_new = f"{cmd_new}{c}" + if c == "]": + appearance = appearance - 1 + + # only if all [..] will be delete if appearance > 0 there is a syntax errror + if appearance == 0: + cmd = cmd_new + + # same for <...> + appearance = 0 + cmd_new = "" + for c in cmd: + if c == "<": + appearance = appearance + 1 + if appearance == 0: + cmd_new = f"{cmd_new}{c}" + if c == ">": + appearance = appearance - 1 + + # only if all <..> will be delete if appearance > 0 there is a syntax errror + if appearance == 0: + cmd = cmd_new + if debug: print("") print(cmd) - cmd = re.sub('set','',cmd) - if debug: - print(cmd) - #while " | " in cmd: - cmd = re.sub('\s+\|\s+','',cmd) - if debug: - print(cmd) - cmd = re.sub('<\S*>','',cmd) + cmd = re.sub('^set','',cmd) if debug: print(cmd) - cmd = re.sub('\[\S\]','',cmd) + cmd = cmd.replace('|','') if debug: print(cmd) cmd = re.sub('\s+','',cmd) @@ -472,10 +497,10 @@ def build_row(app, fromdocname, rowdata): entry += nodes.paragraph(text=item) elif isinstance(cell, bool): if cell: - entry += nodes.paragraph(text="") + entry += nodes.paragraph(text="✔") entry['classes'] = ['coverage-ok'] else: - entry += nodes.paragraph(text="") + entry += nodes.paragraph(text="✕") entry['classes'] = ['coverage-fail'] else: entry += nodes.paragraph(text=cell) @@ -485,8 +510,7 @@ def build_row(app, fromdocname, rowdata): def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type): coverage_list = {} - int_docs = 0 - int_xml = 0 + strip_true_list = [] for cmd in doccmd: coverage_item = { 'doccmd': None, @@ -500,13 +524,9 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type): coverage_item['doccmd'] = cmd['cmd'] coverage_item['doccmd_item'] = cmd coverage_item['indocs'] = True - int_docs += 1 coverage_list[strip_cmd(cmd['cmd'])] = dict(coverage_item) - - #print(coverage_list.keys()) - for cmd in xmlcmd: strip = strip_cmd(cmd['cmd']) @@ -524,15 +544,16 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type): coverage_item['xmlcmd_item'] = cmd coverage_item['inxml'] = True coverage_item['xmlfilename'] = cmd['filename'] - int_xml += 1 coverage_list[strip] = dict(coverage_item) else: coverage_list[strip]['xmlcmd'] = cmd['cmd'] coverage_list[strip]['xmlcmd_item'] = cmd coverage_list[strip]['inxml'] = True coverage_list[strip]['xmlfilename'] = cmd['filename'] - int_xml += 1 + strip_true_list.append(strip) + + strip_true_list = list(set(strip_true_list)) @@ -540,8 +561,8 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type): tgroup = nodes.tgroup(cols=3) table += tgroup - header = (f'{int_docs}/{len(coverage_list)} in Docs', f'{int_xml}/{len(coverage_list)} in XML', 'Command') - colwidths = (1, 1, 8) + header = (f'Status {len(strip_true_list)}/{len(coverage_list)}', 'Documentaion', 'XML') + colwidths = (5, 50 , 50) table = nodes.table() tgroup = nodes.tgroup(cols=len(header)) table += tgroup @@ -553,28 +574,34 @@ def process_coverage(app, fromdocname, doccmd, xmlcmd, cli_type): tbody = nodes.tbody() tgroup += tbody for entry in sorted(coverage_list): - body_text_list = [] + doc_cmd_text = [] + doc_xml_text = [] if coverage_list[entry]['indocs']: - body_text_list.append(coverage_list[entry]['doccmd_item']) + doc_cmd_text.append(coverage_list[entry]['doccmd_item']) else: - body_text_list.append('Not documented yet') + doc_cmd_text.append('not yet documented') if coverage_list[entry]['inxml']: - body_text_list.append("------------------") - body_text_list.append(str(coverage_list[entry]['xmlfilename']) + ":") - body_text_list.append(coverage_list[entry]['xmlcmd']) + doc_xml_text.append(str(coverage_list[entry]['xmlfilename']) + ":") + doc_xml_text.append(coverage_list[entry]['xmlcmd']) else: - body_text_list.append('Nothing found in XML Definitions') + doc_xml_text.append('Nothing found in XML Definitions') - + if not coverage_list[entry]['indocs'] or not coverage_list[entry]['inxml']: + status = False + else: + status = True + tbody += build_row(app, fromdocname, ( - coverage_list[entry]['indocs'], - coverage_list[entry]['inxml'], - body_text_list + status, + doc_cmd_text, + doc_xml_text + ) ) + table['ids'] = [f'table-{cli_type}'] return table def process_cmd_node(app, cmd, fromdocname, cli_type): @@ -655,7 +682,7 @@ def handle_document_meta_data(app, document): try: lastproofread_time = datetime.strptime(lastproofread, '%Y-%m-%d') delta = datetime.now() - lastproofread_time - if delta.days > 180: + if delta.days > 365: logger.warning(f'{delta.days} days since last proofread {app.env.doc2path(docname)}') except Exception as e: @@ -663,5 +690,3 @@ def handle_document_meta_data(app, document): else: pass #logger.warning(f'lastproofread meta data missing in {app.env.doc2path(docname)}') - - diff --git a/docs/_include/vyos-1x b/docs/_include/vyos-1x -Subproject ec13cac66ba612ecc36053158c7517c8fe99354 +Subproject 5b2e7394403461598cf71d0d5cc9ac6e011e9ee diff --git a/docs/_static/css/DataTables-1.11.5/images/sort_asc.png b/docs/_static/css/DataTables-1.11.5/images/sort_asc.png Binary files differnew file mode 100644 index 00000000..e1ba61a8 --- /dev/null +++ b/docs/_static/css/DataTables-1.11.5/images/sort_asc.png diff --git a/docs/_static/css/DataTables-1.11.5/images/sort_asc_disabled.png b/docs/_static/css/DataTables-1.11.5/images/sort_asc_disabled.png Binary files differnew file mode 100644 index 00000000..c9fdd8a1 --- /dev/null +++ b/docs/_static/css/DataTables-1.11.5/images/sort_asc_disabled.png diff --git a/docs/_static/css/DataTables-1.11.5/images/sort_both.png b/docs/_static/css/DataTables-1.11.5/images/sort_both.png Binary files differnew file mode 100644 index 00000000..af5bc7c5 --- /dev/null +++ b/docs/_static/css/DataTables-1.11.5/images/sort_both.png diff --git a/docs/_static/css/DataTables-1.11.5/images/sort_desc.png b/docs/_static/css/DataTables-1.11.5/images/sort_desc.png Binary files differnew file mode 100644 index 00000000..0e156deb --- /dev/null +++ b/docs/_static/css/DataTables-1.11.5/images/sort_desc.png diff --git a/docs/_static/css/DataTables-1.11.5/images/sort_desc_disabled.png b/docs/_static/css/DataTables-1.11.5/images/sort_desc_disabled.png Binary files differnew file mode 100644 index 00000000..fb11dfe2 --- /dev/null +++ b/docs/_static/css/DataTables-1.11.5/images/sort_desc_disabled.png diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index c90fc8cb..331a7720 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -1,3 +1,8 @@ +div.card-header { + font-weight: bold; + background: #fdab10; +} + span.opcmd, span.cfgcmd { font-weight: bold; @@ -15,13 +20,13 @@ span.cfgcmd:before { margin-right: 0px; } -td p a.cmdlink span.cfgcmd:before, -td p a.cmdlink span.opcmd:before { +td a.cmdlink span.cfgcmd:before, +td a.cmdlink span.opcmd:before { content: ""; } -td p a.cmdlink, -td p a.cmdlink { +td a.cmdlink, +td a.cmdlink { margin-left: 0px; } @@ -165,15 +170,15 @@ a.cmdlink span:hover{ .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td.coverage-ok, .rst-content table.docutils td.coverage-ok { - background-color: green; - color: black; + color: green; + text-align: center; } - .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td.coverage-fail, .rst-content table.docutils td.coverage-fail { - background-color: red; - color: black; + color: red; + text-align: center; + } @media screen and (max-width: 768px) { diff --git a/docs/_static/css/datatables.css b/docs/_static/css/datatables.css new file mode 100644 index 00000000..94032981 --- /dev/null +++ b/docs/_static/css/datatables.css @@ -0,0 +1,497 @@ +/* + * This combined file was created by the DataTables downloader builder: + * https://datatables.net/download + * + * To rebuild or modify this file with the latest versions of the included + * software please visit: + * https://datatables.net/download/#dt/dt-1.11.5 + * + * Included libraries: + * DataTables 1.11.5 + */ + +table.dataTable th.dt-left, +table.dataTable td.dt-left { + text-align: left; +} +table.dataTable th.dt-center, +table.dataTable td.dt-center, +table.dataTable td.dataTables_empty { + text-align: center; +} +table.dataTable th.dt-right, +table.dataTable td.dt-right { + text-align: right; +} +table.dataTable th.dt-justify, +table.dataTable td.dt-justify { + text-align: justify; +} +table.dataTable th.dt-nowrap, +table.dataTable td.dt-nowrap { + white-space: nowrap; +} +table.dataTable thead th.dt-head-left, +table.dataTable thead td.dt-head-left, +table.dataTable tfoot th.dt-head-left, +table.dataTable tfoot td.dt-head-left { + text-align: left; +} +table.dataTable thead th.dt-head-center, +table.dataTable thead td.dt-head-center, +table.dataTable tfoot th.dt-head-center, +table.dataTable tfoot td.dt-head-center { + text-align: center; +} +table.dataTable thead th.dt-head-right, +table.dataTable thead td.dt-head-right, +table.dataTable tfoot th.dt-head-right, +table.dataTable tfoot td.dt-head-right { + text-align: right; +} +table.dataTable thead th.dt-head-justify, +table.dataTable thead td.dt-head-justify, +table.dataTable tfoot th.dt-head-justify, +table.dataTable tfoot td.dt-head-justify { + text-align: justify; +} +table.dataTable thead th.dt-head-nowrap, +table.dataTable thead td.dt-head-nowrap, +table.dataTable tfoot th.dt-head-nowrap, +table.dataTable tfoot td.dt-head-nowrap { + white-space: nowrap; +} +table.dataTable tbody th.dt-body-left, +table.dataTable tbody td.dt-body-left { + text-align: left; +} +table.dataTable tbody th.dt-body-center, +table.dataTable tbody td.dt-body-center { + text-align: center; +} +table.dataTable tbody th.dt-body-right, +table.dataTable tbody td.dt-body-right { + text-align: right; +} +table.dataTable tbody th.dt-body-justify, +table.dataTable tbody td.dt-body-justify { + text-align: justify; +} +table.dataTable tbody th.dt-body-nowrap, +table.dataTable tbody td.dt-body-nowrap { + white-space: nowrap; +} +table.dataTable td.dt-control { + text-align: center; + cursor: pointer; +} +table.dataTable td.dt-control:before { + height: 1em; + width: 1em; + margin-top: -9px; + display: inline-block; + color: white; + border: 0.15em solid white; + border-radius: 1em; + box-shadow: 0 0 0.2em #444; + box-sizing: content-box; + text-align: center; + text-indent: 0 !important; + font-family: "Courier New", Courier, monospace; + line-height: 1em; + content: "+"; + background-color: #31b131; +} +table.dataTable tr.dt-hasChild td.dt-control:before { + content: "-"; + background-color: #d33333; +} + +/* + * Table styles + */ +table.dataTable { + width: 100%; + margin: 0 auto; + clear: both; + border-collapse: separate; + border-spacing: 0; + /* + * Header and footer styles + */ + /* + * Body styles + */ +} +table.dataTable thead th, +table.dataTable tfoot th { + font-weight: bold; +} +table.dataTable thead th, +table.dataTable thead td { + padding: 10px 18px; + border-bottom: 1px solid #111; +} +table.dataTable thead th:active, +table.dataTable thead td:active { + outline: none; +} +table.dataTable tfoot th, +table.dataTable tfoot td { + padding: 10px 18px 6px 18px; + border-top: 1px solid #111; +} +table.dataTable thead .sorting, +table.dataTable thead .sorting_asc, +table.dataTable thead .sorting_desc, +table.dataTable thead .sorting_asc_disabled, +table.dataTable thead .sorting_desc_disabled { + cursor: pointer; + *cursor: hand; + background-repeat: no-repeat; + background-position: center right; +} +table.dataTable thead .sorting { + background-image: url("DataTables-1.11.5/images/sort_both.png"); +} +table.dataTable thead .sorting_asc { + background-image: url("DataTables-1.11.5/images/sort_asc.png") !important; +} +table.dataTable thead .sorting_desc { + background-image: url("DataTables-1.11.5/images/sort_desc.png") !important; +} +table.dataTable thead .sorting_asc_disabled { + background-image: url("DataTables-1.11.5/images/sort_asc_disabled.png"); +} +table.dataTable thead .sorting_desc_disabled { + background-image: url("DataTables-1.11.5/images/sort_desc_disabled.png"); +} +table.dataTable tbody tr { + background-color: #ffffff; +} +table.dataTable tbody tr.selected { + background-color: #B0BED9; +} +table.dataTable tbody th, +table.dataTable tbody td { + padding: 8px 10px; +} +table.dataTable.row-border tbody th, table.dataTable.row-border tbody td, table.dataTable.display tbody th, table.dataTable.display tbody td { + border-top: 1px solid #ddd; +} +table.dataTable.row-border tbody tr:first-child th, +table.dataTable.row-border tbody tr:first-child td, table.dataTable.display tbody tr:first-child th, +table.dataTable.display tbody tr:first-child td { + border-top: none; +} +table.dataTable.cell-border tbody th, table.dataTable.cell-border tbody td { + border-top: 1px solid #ddd; + border-right: 1px solid #ddd; +} +table.dataTable.cell-border tbody tr th:first-child, +table.dataTable.cell-border tbody tr td:first-child { + border-left: 1px solid #ddd; +} +table.dataTable.cell-border tbody tr:first-child th, +table.dataTable.cell-border tbody tr:first-child td { + border-top: none; +} +table.dataTable.stripe tbody tr.odd, table.dataTable.display tbody tr.odd { + background-color: #f9f9f9; +} +table.dataTable.stripe tbody tr.odd.selected, table.dataTable.display tbody tr.odd.selected { + background-color: #acbad4; +} +table.dataTable.hover tbody tr:hover, table.dataTable.display tbody tr:hover { + background-color: #f6f6f6; +} +table.dataTable.hover tbody tr:hover.selected, table.dataTable.display tbody tr:hover.selected { + background-color: #aab7d1; +} +table.dataTable.order-column tbody tr > .sorting_1, +table.dataTable.order-column tbody tr > .sorting_2, +table.dataTable.order-column tbody tr > .sorting_3, table.dataTable.display tbody tr > .sorting_1, +table.dataTable.display tbody tr > .sorting_2, +table.dataTable.display tbody tr > .sorting_3 { + background-color: #fafafa; +} +table.dataTable.order-column tbody tr.selected > .sorting_1, +table.dataTable.order-column tbody tr.selected > .sorting_2, +table.dataTable.order-column tbody tr.selected > .sorting_3, table.dataTable.display tbody tr.selected > .sorting_1, +table.dataTable.display tbody tr.selected > .sorting_2, +table.dataTable.display tbody tr.selected > .sorting_3 { + background-color: #acbad5; +} +table.dataTable.display tbody tr.odd > .sorting_1, table.dataTable.order-column.stripe tbody tr.odd > .sorting_1 { + background-color: #f1f1f1; +} +table.dataTable.display tbody tr.odd > .sorting_2, table.dataTable.order-column.stripe tbody tr.odd > .sorting_2 { + background-color: #f3f3f3; +} +table.dataTable.display tbody tr.odd > .sorting_3, table.dataTable.order-column.stripe tbody tr.odd > .sorting_3 { + background-color: whitesmoke; +} +table.dataTable.display tbody tr.odd.selected > .sorting_1, table.dataTable.order-column.stripe tbody tr.odd.selected > .sorting_1 { + background-color: #a6b4cd; +} +table.dataTable.display tbody tr.odd.selected > .sorting_2, table.dataTable.order-column.stripe tbody tr.odd.selected > .sorting_2 { + background-color: #a8b5cf; +} +table.dataTable.display tbody tr.odd.selected > .sorting_3, table.dataTable.order-column.stripe tbody tr.odd.selected > .sorting_3 { + background-color: #a9b7d1; +} +table.dataTable.display tbody tr.even > .sorting_1, table.dataTable.order-column.stripe tbody tr.even > .sorting_1 { + background-color: #fafafa; +} +table.dataTable.display tbody tr.even > .sorting_2, table.dataTable.order-column.stripe tbody tr.even > .sorting_2 { + background-color: #fcfcfc; +} +table.dataTable.display tbody tr.even > .sorting_3, table.dataTable.order-column.stripe tbody tr.even > .sorting_3 { + background-color: #fefefe; +} +table.dataTable.display tbody tr.even.selected > .sorting_1, table.dataTable.order-column.stripe tbody tr.even.selected > .sorting_1 { + background-color: #acbad5; +} +table.dataTable.display tbody tr.even.selected > .sorting_2, table.dataTable.order-column.stripe tbody tr.even.selected > .sorting_2 { + background-color: #aebcd6; +} +table.dataTable.display tbody tr.even.selected > .sorting_3, table.dataTable.order-column.stripe tbody tr.even.selected > .sorting_3 { + background-color: #afbdd8; +} +table.dataTable.display tbody tr:hover > .sorting_1, table.dataTable.order-column.hover tbody tr:hover > .sorting_1 { + background-color: #eaeaea; +} +table.dataTable.display tbody tr:hover > .sorting_2, table.dataTable.order-column.hover tbody tr:hover > .sorting_2 { + background-color: #ececec; +} +table.dataTable.display tbody tr:hover > .sorting_3, table.dataTable.order-column.hover tbody tr:hover > .sorting_3 { + background-color: #efefef; +} +table.dataTable.display tbody tr:hover.selected > .sorting_1, table.dataTable.order-column.hover tbody tr:hover.selected > .sorting_1 { + background-color: #a2aec7; +} +table.dataTable.display tbody tr:hover.selected > .sorting_2, table.dataTable.order-column.hover tbody tr:hover.selected > .sorting_2 { + background-color: #a3b0c9; +} +table.dataTable.display tbody tr:hover.selected > .sorting_3, table.dataTable.order-column.hover tbody tr:hover.selected > .sorting_3 { + background-color: #a5b2cb; +} +table.dataTable.no-footer { + border-bottom: 1px solid #111; +} +table.dataTable.nowrap th, table.dataTable.nowrap td { + white-space: nowrap; +} +table.dataTable.compact thead th, +table.dataTable.compact thead td { + padding: 4px 17px; +} +table.dataTable.compact tfoot th, +table.dataTable.compact tfoot td { + padding: 4px; +} +table.dataTable.compact tbody th, +table.dataTable.compact tbody td { + padding: 4px; +} + +table.dataTable th, +table.dataTable td { + box-sizing: content-box; +} + +/* + * Control feature layout + */ +.dataTables_wrapper { + position: relative; + clear: both; + margin-bottom: 24px; +} +.dataTables_wrapper .dataTables_length { + float: left; +} +.dataTables_wrapper .dataTables_length select { + border: 1px solid #aaa; + border-radius: 3px; + padding: 5px; + background-color: transparent; + padding: 4px; +} +.dataTables_wrapper .dataTables_filter { + float: right; + text-align: right; +} +.dataTables_wrapper .dataTables_filter input { + border: 1px solid #aaa; + border-radius: 3px; + padding: 5px; + background-color: transparent; + margin-left: 3px; +} +.dataTables_wrapper .dataTables_info { + clear: both; + float: left; + padding-top: 0.755em; +} +.dataTables_wrapper .dataTables_paginate { + float: right; + text-align: right; + padding-top: 0.25em; +} +.dataTables_wrapper .dataTables_paginate .paginate_button { + box-sizing: border-box; + display: inline-block; + min-width: 1.5em; + padding: 0.5em 1em; + margin-left: 2px; + text-align: center; + text-decoration: none !important; + cursor: pointer; + *cursor: hand; + color: #333 !important; + border: 1px solid transparent; + border-radius: 2px; +} +.dataTables_wrapper .dataTables_paginate .paginate_button.current, .dataTables_wrapper .dataTables_paginate .paginate_button.current:hover { + color: #333 !important; + border: 1px solid #979797; + background-color: white; + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, white), color-stop(100%, #dcdcdc)); + /* Chrome,Safari4+ */ + background: -webkit-linear-gradient(top, white 0%, #dcdcdc 100%); + /* Chrome10+,Safari5.1+ */ + background: -moz-linear-gradient(top, white 0%, #dcdcdc 100%); + /* FF3.6+ */ + background: -ms-linear-gradient(top, white 0%, #dcdcdc 100%); + /* IE10+ */ + background: -o-linear-gradient(top, white 0%, #dcdcdc 100%); + /* Opera 11.10+ */ + background: linear-gradient(to bottom, white 0%, #dcdcdc 100%); + /* W3C */ +} +.dataTables_wrapper .dataTables_paginate .paginate_button.disabled, .dataTables_wrapper .dataTables_paginate .paginate_button.disabled:hover, .dataTables_wrapper .dataTables_paginate .paginate_button.disabled:active { + cursor: default; + color: #666 !important; + border: 1px solid transparent; + background: transparent; + box-shadow: none; +} +.dataTables_wrapper .dataTables_paginate .paginate_button:hover { + color: white !important; + border: 1px solid #111; + background-color: #585858; + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #585858), color-stop(100%, #111)); + /* Chrome,Safari4+ */ + background: -webkit-linear-gradient(top, #585858 0%, #111 100%); + /* Chrome10+,Safari5.1+ */ + background: -moz-linear-gradient(top, #585858 0%, #111 100%); + /* FF3.6+ */ + background: -ms-linear-gradient(top, #585858 0%, #111 100%); + /* IE10+ */ + background: -o-linear-gradient(top, #585858 0%, #111 100%); + /* Opera 11.10+ */ + background: linear-gradient(to bottom, #585858 0%, #111 100%); + /* W3C */ +} +.dataTables_wrapper .dataTables_paginate .paginate_button:active { + outline: none; + background-color: #2b2b2b; + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #2b2b2b), color-stop(100%, #0c0c0c)); + /* Chrome,Safari4+ */ + background: -webkit-linear-gradient(top, #2b2b2b 0%, #0c0c0c 100%); + /* Chrome10+,Safari5.1+ */ + background: -moz-linear-gradient(top, #2b2b2b 0%, #0c0c0c 100%); + /* FF3.6+ */ + background: -ms-linear-gradient(top, #2b2b2b 0%, #0c0c0c 100%); + /* IE10+ */ + background: -o-linear-gradient(top, #2b2b2b 0%, #0c0c0c 100%); + /* Opera 11.10+ */ + background: linear-gradient(to bottom, #2b2b2b 0%, #0c0c0c 100%); + /* W3C */ + box-shadow: inset 0 0 3px #111; +} +.dataTables_wrapper .dataTables_paginate .ellipsis { + padding: 0 1em; +} +.dataTables_wrapper .dataTables_processing { + position: absolute; + top: 50%; + left: 50%; + width: 100%; + height: 40px; + margin-left: -50%; + margin-top: -25px; + padding-top: 20px; + text-align: center; + font-size: 1.2em; + background-color: white; + background: -webkit-gradient(linear, left top, right top, color-stop(0%, rgba(255, 255, 255, 0)), color-stop(25%, rgba(255, 255, 255, 0.9)), color-stop(75%, rgba(255, 255, 255, 0.9)), color-stop(100%, rgba(255, 255, 255, 0))); + background: -webkit-linear-gradient(left, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0.9) 25%, rgba(255, 255, 255, 0.9) 75%, rgba(255, 255, 255, 0) 100%); + background: -moz-linear-gradient(left, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0.9) 25%, rgba(255, 255, 255, 0.9) 75%, rgba(255, 255, 255, 0) 100%); + background: -ms-linear-gradient(left, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0.9) 25%, rgba(255, 255, 255, 0.9) 75%, rgba(255, 255, 255, 0) 100%); + background: -o-linear-gradient(left, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0.9) 25%, rgba(255, 255, 255, 0.9) 75%, rgba(255, 255, 255, 0) 100%); + background: linear-gradient(to right, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0.9) 25%, rgba(255, 255, 255, 0.9) 75%, rgba(255, 255, 255, 0) 100%); +} +.dataTables_wrapper .dataTables_length, +.dataTables_wrapper .dataTables_filter, +.dataTables_wrapper .dataTables_info, +.dataTables_wrapper .dataTables_processing, +.dataTables_wrapper .dataTables_paginate { + color: #333; +} +.dataTables_wrapper .dataTables_scroll { + clear: both; +} +.dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody { + *margin-top: -1px; + -webkit-overflow-scrolling: touch; +} +.dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > thead > tr > th, .dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > thead > tr > td, .dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > tbody > tr > th, .dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > tbody > tr > td { + vertical-align: middle; +} +.dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > thead > tr > th > div.dataTables_sizing, +.dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > thead > tr > td > div.dataTables_sizing, .dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > tbody > tr > th > div.dataTables_sizing, +.dataTables_wrapper .dataTables_scroll div.dataTables_scrollBody > table > tbody > tr > td > div.dataTables_sizing { + height: 0; + overflow: hidden; + margin: 0 !important; + padding: 0 !important; +} +.dataTables_wrapper.no-footer .dataTables_scrollBody { + border-bottom: 1px solid #111; +} +.dataTables_wrapper.no-footer div.dataTables_scrollHead table.dataTable, +.dataTables_wrapper.no-footer div.dataTables_scrollBody > table { + border-bottom: none; +} +.dataTables_wrapper:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +@media screen and (max-width: 767px) { + .dataTables_wrapper .dataTables_info, +.dataTables_wrapper .dataTables_paginate { + float: none; + text-align: center; + } + .dataTables_wrapper .dataTables_paginate { + margin-top: 0.5em; + } +} +@media screen and (max-width: 640px) { + .dataTables_wrapper .dataTables_length, +.dataTables_wrapper .dataTables_filter { + float: none; + text-align: center; + } + .dataTables_wrapper .dataTables_filter { + margin-top: 0.5em; + } +} + + diff --git a/docs/_static/images/VyOS_Dual-Hub_DMVPN.png b/docs/_static/images/VyOS_Dual-Hub_DMVPN.png Binary files differnew file mode 100644 index 00000000..9c25a308 --- /dev/null +++ b/docs/_static/images/VyOS_Dual-Hub_DMVPN.png diff --git a/docs/_static/js/datatables.js b/docs/_static/js/datatables.js new file mode 100644 index 00000000..34a64607 --- /dev/null +++ b/docs/_static/js/datatables.js @@ -0,0 +1,15389 @@ +/* + * This combined file was created by the DataTables downloader builder: + * https://datatables.net/download + * + * To rebuild or modify this file with the latest versions of the included + * software please visit: + * https://datatables.net/download/#dt/dt-1.11.5 + * + * Included libraries: + * DataTables 1.11.5 + */ + +/*! DataTables 1.11.5 + * ©2008-2021 SpryMedia Ltd - datatables.net/license + */ + +/** + * @summary DataTables + * @description Paginate, search and order HTML tables + * @version 1.11.5 + * @file jquery.dataTables.js + * @author SpryMedia Ltd + * @contact www.datatables.net + * @copyright Copyright 2008-2021 SpryMedia Ltd. + * + * This source file is free software, available under the following license: + * MIT license - http://datatables.net/license + * + * This source file is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details. + * + * For details please refer to: http://www.datatables.net + */ + +/*jslint evil: true, undef: true, browser: true */ +/*globals $,require,jQuery,define,_selector_run,_selector_opts,_selector_first,_selector_row_indexes,_ext,_Api,_api_register,_api_registerPlural,_re_new_lines,_re_html,_re_formatted_numeric,_re_escape_regex,_empty,_intVal,_numToDecimal,_isNumber,_isHtml,_htmlNumeric,_pluck,_pluck_order,_range,_stripHtml,_unique,_fnBuildAjax,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnAjaxDataSrc,_fnAddColumn,_fnColumnOptions,_fnAdjustColumnSizing,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnVisbleColumns,_fnGetColumns,_fnColumnTypes,_fnApplyColumnDefs,_fnHungarianMap,_fnCamelToHungarian,_fnLanguageCompat,_fnBrowserDetect,_fnAddData,_fnAddTr,_fnNodeToDataIndex,_fnNodeToColumnIndex,_fnGetCellData,_fnSetCellData,_fnSplitObjNotation,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnGetDataMaster,_fnClearTable,_fnDeleteIndex,_fnInvalidate,_fnGetRowElements,_fnCreateTr,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAddOptionsHtml,_fnDetectHeader,_fnGetUniqueThs,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnFilterCreateSearch,_fnEscapeRegex,_fnFilterData,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnInfoMacros,_fnInitialise,_fnInitComplete,_fnLengthChange,_fnFeatureHtmlLength,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnFeatureHtmlTable,_fnScrollDraw,_fnApplyToChildren,_fnCalculateColumnWidths,_fnThrottle,_fnConvertToWidth,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnSortFlatten,_fnSort,_fnSortAria,_fnSortListener,_fnSortAttachListener,_fnSortingClasses,_fnSortData,_fnSaveState,_fnLoadState,_fnSettingsFromNode,_fnLog,_fnMap,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnLengthOverflow,_fnRenderer,_fnDataSource,_fnRowAttributes*/ + +(function( factory ) { + "use strict"; + + if ( typeof define === 'function' && define.amd ) { + // AMD + define( ['jquery'], function ( $ ) { + return factory( $, window, document ); + } ); + } + else if ( typeof exports === 'object' ) { + // CommonJS + module.exports = function (root, $) { + if ( ! root ) { + // CommonJS environments without a window global must pass a + // root. This will give an error otherwise + root = window; + } + + if ( ! $ ) { + $ = typeof window !== 'undefined' ? // jQuery's factory checks for a global window + require('jquery') : + require('jquery')( root ); + } + + return factory( $, root, root.document ); + }; + } + else { + // Browser + window.DataTable = factory( jQuery, window, document ); + } +} +(function( $, window, document, undefined ) { + "use strict"; + + + var DataTable = function ( selector, options ) + { + // When creating with `new`, create a new DataTable, returning the API instance + if (this instanceof DataTable) { + return $(selector).DataTable(options); + } + else { + // Argument switching + options = selector; + } + + /** + * Perform a jQuery selector action on the table's TR elements (from the tbody) and + * return the resulting jQuery object. + * @param {string|node|jQuery} sSelector jQuery selector or node collection to act on + * @param {object} [oOpts] Optional parameters for modifying the rows to be included + * @param {string} [oOpts.filter=none] Select TR elements that meet the current filter + * criterion ("applied") or all TR elements (i.e. no filter). + * @param {string} [oOpts.order=current] Order of the TR elements in the processed array. + * Can be either 'current', whereby the current sorting of the table is used, or + * 'original' whereby the original order the data was read into the table is used. + * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page + * ("current") or not ("all"). If 'current' is given, then order is assumed to be + * 'current' and filter is 'applied', regardless of what they might be given as. + * @returns {object} jQuery object, filtered by the given selector. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Highlight every second row + * oTable.$('tr:odd').css('backgroundColor', 'blue'); + * } ); + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Filter to rows with 'Webkit' in them, add a background colour and then + * // remove the filter, thus highlighting the 'Webkit' rows only. + * oTable.fnFilter('Webkit'); + * oTable.$('tr', {"search": "applied"}).css('backgroundColor', 'blue'); + * oTable.fnFilter(''); + * } ); + */ + this.$ = function ( sSelector, oOpts ) + { + return this.api(true).$( sSelector, oOpts ); + }; + + + /** + * Almost identical to $ in operation, but in this case returns the data for the matched + * rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes + * rather than any descendants, so the data can be obtained for the row/cell. If matching + * rows are found, the data returned is the original data array/object that was used to + * create the row (or a generated array if from a DOM source). + * + * This method is often useful in-combination with $ where both functions are given the + * same parameters and the array indexes will match identically. + * @param {string|node|jQuery} sSelector jQuery selector or node collection to act on + * @param {object} [oOpts] Optional parameters for modifying the rows to be included + * @param {string} [oOpts.filter=none] Select elements that meet the current filter + * criterion ("applied") or all elements (i.e. no filter). + * @param {string} [oOpts.order=current] Order of the data in the processed array. + * Can be either 'current', whereby the current sorting of the table is used, or + * 'original' whereby the original order the data was read into the table is used. + * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page + * ("current") or not ("all"). If 'current' is given, then order is assumed to be + * 'current' and filter is 'applied', regardless of what they might be given as. + * @returns {array} Data for the matched elements. If any elements, as a result of the + * selector, were not TR, TD or TH elements in the DataTable, they will have a null + * entry in the array. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Get the data from the first row in the table + * var data = oTable._('tr:first'); + * + * // Do something useful with the data + * alert( "First cell is: "+data[0] ); + * } ); + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Filter to 'Webkit' and get all data for + * oTable.fnFilter('Webkit'); + * var data = oTable._('tr', {"search": "applied"}); + * + * // Do something with the data + * alert( data.length+" rows matched the search" ); + * } ); + */ + this._ = function ( sSelector, oOpts ) + { + return this.api(true).rows( sSelector, oOpts ).data(); + }; + + + /** + * Create a DataTables Api instance, with the currently selected tables for + * the Api's context. + * @param {boolean} [traditional=false] Set the API instance's context to be + * only the table referred to by the `DataTable.ext.iApiIndex` option, as was + * used in the API presented by DataTables 1.9- (i.e. the traditional mode), + * or if all tables captured in the jQuery object should be used. + * @return {DataTables.Api} + */ + this.api = function ( traditional ) + { + return traditional ? + new _Api( + _fnSettingsFromNode( this[ _ext.iApiIndex ] ) + ) : + new _Api( this ); + }; + + + /** + * Add a single new row or multiple rows of data to the table. Please note + * that this is suitable for client-side processing only - if you are using + * server-side processing (i.e. "bServerSide": true), then to add data, you + * must add it to the data source, i.e. the server-side, through an Ajax call. + * @param {array|object} data The data to be added to the table. This can be: + * <ul> + * <li>1D array of data - add a single row with the data provided</li> + * <li>2D array of arrays - add multiple rows in a single call</li> + * <li>object - data object when using <i>mData</i></li> + * <li>array of objects - multiple data objects when using <i>mData</i></li> + * </ul> + * @param {bool} [redraw=true] redraw the table or not + * @returns {array} An array of integers, representing the list of indexes in + * <i>aoData</i> ({@link DataTable.models.oSettings}) that have been added to + * the table. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * // Global var for counter + * var giCount = 2; + * + * $(document).ready(function() { + * $('#example').dataTable(); + * } ); + * + * function fnClickAddRow() { + * $('#example').dataTable().fnAddData( [ + * giCount+".1", + * giCount+".2", + * giCount+".3", + * giCount+".4" ] + * ); + * + * giCount++; + * } + */ + this.fnAddData = function( data, redraw ) + { + var api = this.api( true ); + + /* Check if we want to add multiple rows or not */ + var rows = Array.isArray(data) && ( Array.isArray(data[0]) || $.isPlainObject(data[0]) ) ? + api.rows.add( data ) : + api.row.add( data ); + + if ( redraw === undefined || redraw ) { + api.draw(); + } + + return rows.flatten().toArray(); + }; + + + /** + * This function will make DataTables recalculate the column sizes, based on the data + * contained in the table and the sizes applied to the columns (in the DOM, CSS or + * through the sWidth parameter). This can be useful when the width of the table's + * parent element changes (for example a window resize). + * @param {boolean} [bRedraw=true] Redraw the table or not, you will typically want to + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable( { + * "sScrollY": "200px", + * "bPaginate": false + * } ); + * + * $(window).on('resize', function () { + * oTable.fnAdjustColumnSizing(); + * } ); + * } ); + */ + this.fnAdjustColumnSizing = function ( bRedraw ) + { + var api = this.api( true ).columns.adjust(); + var settings = api.settings()[0]; + var scroll = settings.oScroll; + + if ( bRedraw === undefined || bRedraw ) { + api.draw( false ); + } + else if ( scroll.sX !== "" || scroll.sY !== "" ) { + /* If not redrawing, but scrolling, we want to apply the new column sizes anyway */ + _fnScrollDraw( settings ); + } + }; + + + /** + * Quickly and simply clear a table + * @param {bool} [bRedraw=true] redraw the table or not + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...) + * oTable.fnClearTable(); + * } ); + */ + this.fnClearTable = function( bRedraw ) + { + var api = this.api( true ).clear(); + + if ( bRedraw === undefined || bRedraw ) { + api.draw(); + } + }; + + + /** + * The exact opposite of 'opening' a row, this function will close any rows which + * are currently 'open'. + * @param {node} nTr the table row to 'close' + * @returns {int} 0 on success, or 1 if failed (can't find the row) + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable; + * + * // 'open' an information row when a row is clicked on + * $('#example tbody tr').click( function () { + * if ( oTable.fnIsOpen(this) ) { + * oTable.fnClose( this ); + * } else { + * oTable.fnOpen( this, "Temporary row opened", "info_row" ); + * } + * } ); + * + * oTable = $('#example').dataTable(); + * } ); + */ + this.fnClose = function( nTr ) + { + this.api( true ).row( nTr ).child.hide(); + }; + + + /** + * Remove a row for the table + * @param {mixed} target The index of the row from aoData to be deleted, or + * the TR element you want to delete + * @param {function|null} [callBack] Callback function + * @param {bool} [redraw=true] Redraw the table or not + * @returns {array} The row that was deleted + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Immediately remove the first row + * oTable.fnDeleteRow( 0 ); + * } ); + */ + this.fnDeleteRow = function( target, callback, redraw ) + { + var api = this.api( true ); + var rows = api.rows( target ); + var settings = rows.settings()[0]; + var data = settings.aoData[ rows[0][0] ]; + + rows.remove(); + + if ( callback ) { + callback.call( this, settings, data ); + } + + if ( redraw === undefined || redraw ) { + api.draw(); + } + + return data; + }; + + + /** + * Restore the table to it's original state in the DOM by removing all of DataTables + * enhancements, alterations to the DOM structure of the table and event listeners. + * @param {boolean} [remove=false] Completely remove the table from the DOM + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * // This example is fairly pointless in reality, but shows how fnDestroy can be used + * var oTable = $('#example').dataTable(); + * oTable.fnDestroy(); + * } ); + */ + this.fnDestroy = function ( remove ) + { + this.api( true ).destroy( remove ); + }; + + + /** + * Redraw the table + * @param {bool} [complete=true] Re-filter and resort (if enabled) the table before the draw. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Re-draw the table - you wouldn't want to do it here, but it's an example :-) + * oTable.fnDraw(); + * } ); + */ + this.fnDraw = function( complete ) + { + // Note that this isn't an exact match to the old call to _fnDraw - it takes + // into account the new data, but can hold position. + this.api( true ).draw( complete ); + }; + + + /** + * Filter the input based on data + * @param {string} sInput String to filter the table on + * @param {int|null} [iColumn] Column to limit filtering to + * @param {bool} [bRegex=false] Treat as regular expression or not + * @param {bool} [bSmart=true] Perform smart filtering or not + * @param {bool} [bShowGlobal=true] Show the input global filter in it's input box(es) + * @param {bool} [bCaseInsensitive=true] Do case-insensitive matching (true) or not (false) + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Sometime later - filter... + * oTable.fnFilter( 'test string' ); + * } ); + */ + this.fnFilter = function( sInput, iColumn, bRegex, bSmart, bShowGlobal, bCaseInsensitive ) + { + var api = this.api( true ); + + if ( iColumn === null || iColumn === undefined ) { + api.search( sInput, bRegex, bSmart, bCaseInsensitive ); + } + else { + api.column( iColumn ).search( sInput, bRegex, bSmart, bCaseInsensitive ); + } + + api.draw(); + }; + + + /** + * Get the data for the whole table, an individual row or an individual cell based on the + * provided parameters. + * @param {int|node} [src] A TR row node, TD/TH cell node or an integer. If given as + * a TR node then the data source for the whole row will be returned. If given as a + * TD/TH cell node then iCol will be automatically calculated and the data for the + * cell returned. If given as an integer, then this is treated as the aoData internal + * data index for the row (see fnGetPosition) and the data for that row used. + * @param {int} [col] Optional column index that you want the data of. + * @returns {array|object|string} If mRow is undefined, then the data for all rows is + * returned. If mRow is defined, just data for that row, and is iCol is + * defined, only data for the designated cell is returned. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * // Row data + * $(document).ready(function() { + * oTable = $('#example').dataTable(); + * + * oTable.$('tr').click( function () { + * var data = oTable.fnGetData( this ); + * // ... do something with the array / object of data for the row + * } ); + * } ); + * + * @example + * // Individual cell data + * $(document).ready(function() { + * oTable = $('#example').dataTable(); + * + * oTable.$('td').click( function () { + * var sData = oTable.fnGetData( this ); + * alert( 'The cell clicked on had the value of '+sData ); + * } ); + * } ); + */ + this.fnGetData = function( src, col ) + { + var api = this.api( true ); + + if ( src !== undefined ) { + var type = src.nodeName ? src.nodeName.toLowerCase() : ''; + + return col !== undefined || type == 'td' || type == 'th' ? + api.cell( src, col ).data() : + api.row( src ).data() || null; + } + + return api.data().toArray(); + }; + + + /** + * Get an array of the TR nodes that are used in the table's body. Note that you will + * typically want to use the '$' API method in preference to this as it is more + * flexible. + * @param {int} [iRow] Optional row index for the TR element you want + * @returns {array|node} If iRow is undefined, returns an array of all TR elements + * in the table's body, or iRow is defined, just the TR element requested. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Get the nodes from the table + * var nNodes = oTable.fnGetNodes( ); + * } ); + */ + this.fnGetNodes = function( iRow ) + { + var api = this.api( true ); + + return iRow !== undefined ? + api.row( iRow ).node() : + api.rows().nodes().flatten().toArray(); + }; + + + /** + * Get the array indexes of a particular cell from it's DOM element + * and column index including hidden columns + * @param {node} node this can either be a TR, TD or TH in the table's body + * @returns {int} If nNode is given as a TR, then a single index is returned, or + * if given as a cell, an array of [row index, column index (visible), + * column index (all)] is given. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * $('#example tbody td').click( function () { + * // Get the position of the current data from the node + * var aPos = oTable.fnGetPosition( this ); + * + * // Get the data array for this row + * var aData = oTable.fnGetData( aPos[0] ); + * + * // Update the data array and return the value + * aData[ aPos[1] ] = 'clicked'; + * this.innerHTML = 'clicked'; + * } ); + * + * // Init DataTables + * oTable = $('#example').dataTable(); + * } ); + */ + this.fnGetPosition = function( node ) + { + var api = this.api( true ); + var nodeName = node.nodeName.toUpperCase(); + + if ( nodeName == 'TR' ) { + return api.row( node ).index(); + } + else if ( nodeName == 'TD' || nodeName == 'TH' ) { + var cell = api.cell( node ).index(); + + return [ + cell.row, + cell.columnVisible, + cell.column + ]; + } + return null; + }; + + + /** + * Check to see if a row is 'open' or not. + * @param {node} nTr the table row to check + * @returns {boolean} true if the row is currently open, false otherwise + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable; + * + * // 'open' an information row when a row is clicked on + * $('#example tbody tr').click( function () { + * if ( oTable.fnIsOpen(this) ) { + * oTable.fnClose( this ); + * } else { + * oTable.fnOpen( this, "Temporary row opened", "info_row" ); + * } + * } ); + * + * oTable = $('#example').dataTable(); + * } ); + */ + this.fnIsOpen = function( nTr ) + { + return this.api( true ).row( nTr ).child.isShown(); + }; + + + /** + * This function will place a new row directly after a row which is currently + * on display on the page, with the HTML contents that is passed into the + * function. This can be used, for example, to ask for confirmation that a + * particular record should be deleted. + * @param {node} nTr The table row to 'open' + * @param {string|node|jQuery} mHtml The HTML to put into the row + * @param {string} sClass Class to give the new TD cell + * @returns {node} The row opened. Note that if the table row passed in as the + * first parameter, is not found in the table, this method will silently + * return. + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable; + * + * // 'open' an information row when a row is clicked on + * $('#example tbody tr').click( function () { + * if ( oTable.fnIsOpen(this) ) { + * oTable.fnClose( this ); + * } else { + * oTable.fnOpen( this, "Temporary row opened", "info_row" ); + * } + * } ); + * + * oTable = $('#example').dataTable(); + * } ); + */ + this.fnOpen = function( nTr, mHtml, sClass ) + { + return this.api( true ) + .row( nTr ) + .child( mHtml, sClass ) + .show() + .child()[0]; + }; + + + /** + * Change the pagination - provides the internal logic for pagination in a simple API + * function. With this function you can have a DataTables table go to the next, + * previous, first or last pages. + * @param {string|int} mAction Paging action to take: "first", "previous", "next" or "last" + * or page number to jump to (integer), note that page 0 is the first page. + * @param {bool} [bRedraw=true] Redraw the table or not + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * oTable.fnPageChange( 'next' ); + * } ); + */ + this.fnPageChange = function ( mAction, bRedraw ) + { + var api = this.api( true ).page( mAction ); + + if ( bRedraw === undefined || bRedraw ) { + api.draw(false); + } + }; + + + /** + * Show a particular column + * @param {int} iCol The column whose display should be changed + * @param {bool} bShow Show (true) or hide (false) the column + * @param {bool} [bRedraw=true] Redraw the table or not + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Hide the second column after initialisation + * oTable.fnSetColumnVis( 1, false ); + * } ); + */ + this.fnSetColumnVis = function ( iCol, bShow, bRedraw ) + { + var api = this.api( true ).column( iCol ).visible( bShow ); + + if ( bRedraw === undefined || bRedraw ) { + api.columns.adjust().draw(); + } + }; + + + /** + * Get the settings for a particular table for external manipulation + * @returns {object} DataTables settings object. See + * {@link DataTable.models.oSettings} + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * var oSettings = oTable.fnSettings(); + * + * // Show an example parameter from the settings + * alert( oSettings._iDisplayStart ); + * } ); + */ + this.fnSettings = function() + { + return _fnSettingsFromNode( this[_ext.iApiIndex] ); + }; + + + /** + * Sort the table by a particular column + * @param {int} iCol the data index to sort on. Note that this will not match the + * 'display index' if you have hidden data entries + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Sort immediately with columns 0 and 1 + * oTable.fnSort( [ [0,'asc'], [1,'asc'] ] ); + * } ); + */ + this.fnSort = function( aaSort ) + { + this.api( true ).order( aaSort ).draw(); + }; + + + /** + * Attach a sort listener to an element for a given column + * @param {node} nNode the element to attach the sort listener to + * @param {int} iColumn the column that a click on this node will sort on + * @param {function} [fnCallback] callback function when sort is run + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * + * // Sort on column 1, when 'sorter' is clicked on + * oTable.fnSortListener( document.getElementById('sorter'), 1 ); + * } ); + */ + this.fnSortListener = function( nNode, iColumn, fnCallback ) + { + this.api( true ).order.listener( nNode, iColumn, fnCallback ); + }; + + + /** + * Update a table cell or row - this method will accept either a single value to + * update the cell with, an array of values with one element for each column or + * an object in the same format as the original data source. The function is + * self-referencing in order to make the multi column updates easier. + * @param {object|array|string} mData Data to update the cell/row with + * @param {node|int} mRow TR element you want to update or the aoData index + * @param {int} [iColumn] The column to update, give as null or undefined to + * update a whole row. + * @param {bool} [bRedraw=true] Redraw the table or not + * @param {bool} [bAction=true] Perform pre-draw actions or not + * @returns {int} 0 on success, 1 on error + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * oTable.fnUpdate( 'Example update', 0, 0 ); // Single cell + * oTable.fnUpdate( ['a', 'b', 'c', 'd', 'e'], $('tbody tr')[0] ); // Row + * } ); + */ + this.fnUpdate = function( mData, mRow, iColumn, bRedraw, bAction ) + { + var api = this.api( true ); + + if ( iColumn === undefined || iColumn === null ) { + api.row( mRow ).data( mData ); + } + else { + api.cell( mRow, iColumn ).data( mData ); + } + + if ( bAction === undefined || bAction ) { + api.columns.adjust(); + } + + if ( bRedraw === undefined || bRedraw ) { + api.draw(); + } + return 0; + }; + + + /** + * Provide a common method for plug-ins to check the version of DataTables being used, in order + * to ensure compatibility. + * @param {string} sVersion Version string to check for, in the format "X.Y.Z". Note that the + * formats "X" and "X.Y" are also acceptable. + * @returns {boolean} true if this version of DataTables is greater or equal to the required + * version, or false if this version of DataTales is not suitable + * @method + * @dtopt API + * @deprecated Since v1.10 + * + * @example + * $(document).ready(function() { + * var oTable = $('#example').dataTable(); + * alert( oTable.fnVersionCheck( '1.9.0' ) ); + * } ); + */ + this.fnVersionCheck = _ext.fnVersionCheck; + + + var _that = this; + var emptyInit = options === undefined; + var len = this.length; + + if ( emptyInit ) { + options = {}; + } + + this.oApi = this.internal = _ext.internal; + + // Extend with old style plug-in API methods + for ( var fn in DataTable.ext.internal ) { + if ( fn ) { + this[fn] = _fnExternApiFunc(fn); + } + } + + this.each(function() { + // For each initialisation we want to give it a clean initialisation + // object that can be bashed around + var o = {}; + var oInit = len > 1 ? // optimisation for single table case + _fnExtend( o, options, true ) : + options; + + /*global oInit,_that,emptyInit*/ + var i=0, iLen, j, jLen, k, kLen; + var sId = this.getAttribute( 'id' ); + var bInitHandedOff = false; + var defaults = DataTable.defaults; + var $this = $(this); + + + /* Sanity check */ + if ( this.nodeName.toLowerCase() != 'table' ) + { + _fnLog( null, 0, 'Non-table node initialisation ('+this.nodeName+')', 2 ); + return; + } + + /* Backwards compatibility for the defaults */ + _fnCompatOpts( defaults ); + _fnCompatCols( defaults.column ); + + /* Convert the camel-case defaults to Hungarian */ + _fnCamelToHungarian( defaults, defaults, true ); + _fnCamelToHungarian( defaults.column, defaults.column, true ); + + /* Setting up the initialisation object */ + _fnCamelToHungarian( defaults, $.extend( oInit, $this.data() ), true ); + + + + /* Check to see if we are re-initialising a table */ + var allSettings = DataTable.settings; + for ( i=0, iLen=allSettings.length ; i<iLen ; i++ ) + { + var s = allSettings[i]; + + /* Base check on table node */ + if ( + s.nTable == this || + (s.nTHead && s.nTHead.parentNode == this) || + (s.nTFoot && s.nTFoot.parentNode == this) + ) { + var bRetrieve = oInit.bRetrieve !== undefined ? oInit.bRetrieve : defaults.bRetrieve; + var bDestroy = oInit.bDestroy !== undefined ? oInit.bDestroy : defaults.bDestroy; + + if ( emptyInit || bRetrieve ) + { + return s.oInstance; + } + else if ( bDestroy ) + { + s.oInstance.fnDestroy(); + break; + } + else + { + _fnLog( s, 0, 'Cannot reinitialise DataTable', 3 ); + return; + } + } + + /* If the element we are initialising has the same ID as a table which was previously + * initialised, but the table nodes don't match (from before) then we destroy the old + * instance by simply deleting it. This is under the assumption that the table has been + * destroyed by other methods. Anyone using non-id selectors will need to do this manually + */ + if ( s.sTableId == this.id ) + { + allSettings.splice( i, 1 ); + break; + } + } + + /* Ensure the table has an ID - required for accessibility */ + if ( sId === null || sId === "" ) + { + sId = "DataTables_Table_"+(DataTable.ext._unique++); + this.id = sId; + } + + /* Create the settings object for this table and set some of the default parameters */ + var oSettings = $.extend( true, {}, DataTable.models.oSettings, { + "sDestroyWidth": $this[0].style.width, + "sInstance": sId, + "sTableId": sId + } ); + oSettings.nTable = this; + oSettings.oApi = _that.internal; + oSettings.oInit = oInit; + + allSettings.push( oSettings ); + + // Need to add the instance after the instance after the settings object has been added + // to the settings array, so we can self reference the table instance if more than one + oSettings.oInstance = (_that.length===1) ? _that : $this.dataTable(); + + // Backwards compatibility, before we apply all the defaults + _fnCompatOpts( oInit ); + _fnLanguageCompat( oInit.oLanguage ); + + // If the length menu is given, but the init display length is not, use the length menu + if ( oInit.aLengthMenu && ! oInit.iDisplayLength ) + { + oInit.iDisplayLength = Array.isArray( oInit.aLengthMenu[0] ) ? + oInit.aLengthMenu[0][0] : oInit.aLengthMenu[0]; + } + + // Apply the defaults and init options to make a single init object will all + // options defined from defaults and instance options. + oInit = _fnExtend( $.extend( true, {}, defaults ), oInit ); + + + // Map the initialisation options onto the settings object + _fnMap( oSettings.oFeatures, oInit, [ + "bPaginate", + "bLengthChange", + "bFilter", + "bSort", + "bSortMulti", + "bInfo", + "bProcessing", + "bAutoWidth", + "bSortClasses", + "bServerSide", + "bDeferRender" + ] ); + _fnMap( oSettings, oInit, [ + "asStripeClasses", + "ajax", + "fnServerData", + "fnFormatNumber", + "sServerMethod", + "aaSorting", + "aaSortingFixed", + "aLengthMenu", + "sPaginationType", + "sAjaxSource", + "sAjaxDataProp", + "iStateDuration", + "sDom", + "bSortCellsTop", + "iTabIndex", + "fnStateLoadCallback", + "fnStateSaveCallback", + "renderer", + "searchDelay", + "rowId", + [ "iCookieDuration", "iStateDuration" ], // backwards compat + [ "oSearch", "oPreviousSearch" ], + [ "aoSearchCols", "aoPreSearchCols" ], + [ "iDisplayLength", "_iDisplayLength" ] + ] ); + _fnMap( oSettings.oScroll, oInit, [ + [ "sScrollX", "sX" ], + [ "sScrollXInner", "sXInner" ], + [ "sScrollY", "sY" ], + [ "bScrollCollapse", "bCollapse" ] + ] ); + _fnMap( oSettings.oLanguage, oInit, "fnInfoCallback" ); + + /* Callback functions which are array driven */ + _fnCallbackReg( oSettings, 'aoDrawCallback', oInit.fnDrawCallback, 'user' ); + _fnCallbackReg( oSettings, 'aoServerParams', oInit.fnServerParams, 'user' ); + _fnCallbackReg( oSettings, 'aoStateSaveParams', oInit.fnStateSaveParams, 'user' ); + _fnCallbackReg( oSettings, 'aoStateLoadParams', oInit.fnStateLoadParams, 'user' ); + _fnCallbackReg( oSettings, 'aoStateLoaded', oInit.fnStateLoaded, 'user' ); + _fnCallbackReg( oSettings, 'aoRowCallback', oInit.fnRowCallback, 'user' ); + _fnCallbackReg( oSettings, 'aoRowCreatedCallback', oInit.fnCreatedRow, 'user' ); + _fnCallbackReg( oSettings, 'aoHeaderCallback', oInit.fnHeaderCallback, 'user' ); + _fnCallbackReg( oSettings, 'aoFooterCallback', oInit.fnFooterCallback, 'user' ); + _fnCallbackReg( oSettings, 'aoInitComplete', oInit.fnInitComplete, 'user' ); + _fnCallbackReg( oSettings, 'aoPreDrawCallback', oInit.fnPreDrawCallback, 'user' ); + + oSettings.rowIdFn = _fnGetObjectDataFn( oInit.rowId ); + + /* Browser support detection */ + _fnBrowserDetect( oSettings ); + + var oClasses = oSettings.oClasses; + + $.extend( oClasses, DataTable.ext.classes, oInit.oClasses ); + $this.addClass( oClasses.sTable ); + + + if ( oSettings.iInitDisplayStart === undefined ) + { + /* Display start point, taking into account the save saving */ + oSettings.iInitDisplayStart = oInit.iDisplayStart; + oSettings._iDisplayStart = oInit.iDisplayStart; + } + + if ( oInit.iDeferLoading !== null ) + { + oSettings.bDeferLoading = true; + var tmp = Array.isArray( oInit.iDeferLoading ); + oSettings._iRecordsDisplay = tmp ? oInit.iDeferLoading[0] : oInit.iDeferLoading; + oSettings._iRecordsTotal = tmp ? oInit.iDeferLoading[1] : oInit.iDeferLoading; + } + + /* Language definitions */ + var oLanguage = oSettings.oLanguage; + $.extend( true, oLanguage, oInit.oLanguage ); + + if ( oLanguage.sUrl ) + { + /* Get the language definitions from a file - because this Ajax call makes the language + * get async to the remainder of this function we use bInitHandedOff to indicate that + * _fnInitialise will be fired by the returned Ajax handler, rather than the constructor + */ + $.ajax( { + dataType: 'json', + url: oLanguage.sUrl, + success: function ( json ) { + _fnCamelToHungarian( defaults.oLanguage, json ); + _fnLanguageCompat( json ); + $.extend( true, oLanguage, json ); + + _fnCallbackFire( oSettings, null, 'i18n', [oSettings]); + _fnInitialise( oSettings ); + }, + error: function () { + // Error occurred loading language file, continue on as best we can + _fnInitialise( oSettings ); + } + } ); + bInitHandedOff = true; + } + else { + _fnCallbackFire( oSettings, null, 'i18n', [oSettings]); + } + + /* + * Stripes + */ + if ( oInit.asStripeClasses === null ) + { + oSettings.asStripeClasses =[ + oClasses.sStripeOdd, + oClasses.sStripeEven + ]; + } + + /* Remove row stripe classes if they are already on the table row */ + var stripeClasses = oSettings.asStripeClasses; + var rowOne = $this.children('tbody').find('tr').eq(0); + if ( $.inArray( true, $.map( stripeClasses, function(el, i) { + return rowOne.hasClass(el); + } ) ) !== -1 ) { + $('tbody tr', this).removeClass( stripeClasses.join(' ') ); + oSettings.asDestroyStripes = stripeClasses.slice(); + } + + /* + * Columns + * See if we should load columns automatically or use defined ones + */ + var anThs = []; + var aoColumnsInit; + var nThead = this.getElementsByTagName('thead'); + if ( nThead.length !== 0 ) + { + _fnDetectHeader( oSettings.aoHeader, nThead[0] ); + anThs = _fnGetUniqueThs( oSettings ); + } + + /* If not given a column array, generate one with nulls */ + if ( oInit.aoColumns === null ) + { + aoColumnsInit = []; + for ( i=0, iLen=anThs.length ; i<iLen ; i++ ) + { + aoColumnsInit.push( null ); + } + } + else + { + aoColumnsInit = oInit.aoColumns; + } + + /* Add the columns */ + for ( i=0, iLen=aoColumnsInit.length ; i<iLen ; i++ ) + { + _fnAddColumn( oSettings, anThs ? anThs[i] : null ); + } + + /* Apply the column definitions */ + _fnApplyColumnDefs( oSettings, oInit.aoColumnDefs, aoColumnsInit, function (iCol, oDef) { + _fnColumnOptions( oSettings, iCol, oDef ); + } ); + + /* HTML5 attribute detection - build an mData object automatically if the + * attributes are found + */ + if ( rowOne.length ) { + var a = function ( cell, name ) { + return cell.getAttribute( 'data-'+name ) !== null ? name : null; + }; + + $( rowOne[0] ).children('th, td').each( function (i, cell) { + var col = oSettings.aoColumns[i]; + + if ( col.mData === i ) { + var sort = a( cell, 'sort' ) || a( cell, 'order' ); + var filter = a( cell, 'filter' ) || a( cell, 'search' ); + + if ( sort !== null || filter !== null ) { + col.mData = { + _: i+'.display', + sort: sort !== null ? i+'.@data-'+sort : undefined, + type: sort !== null ? i+'.@data-'+sort : undefined, + filter: filter !== null ? i+'.@data-'+filter : undefined + }; + + _fnColumnOptions( oSettings, i ); + } + } + } ); + } + + var features = oSettings.oFeatures; + var loadedInit = function () { + /* + * Sorting + * @todo For modularisation (1.11) this needs to do into a sort start up handler + */ + + // If aaSorting is not defined, then we use the first indicator in asSorting + // in case that has been altered, so the default sort reflects that option + if ( oInit.aaSorting === undefined ) { + var sorting = oSettings.aaSorting; + for ( i=0, iLen=sorting.length ; i<iLen ; i++ ) { + sorting[i][1] = oSettings.aoColumns[ i ].asSorting[0]; + } + } + + /* Do a first pass on the sorting classes (allows any size changes to be taken into + * account, and also will apply sorting disabled classes if disabled + */ + _fnSortingClasses( oSettings ); + + if ( features.bSort ) { + _fnCallbackReg( oSettings, 'aoDrawCallback', function () { + if ( oSettings.bSorted ) { + var aSort = _fnSortFlatten( oSettings ); + var sortedColumns = {}; + + $.each( aSort, function (i, val) { + sortedColumns[ val.src ] = val.dir; + } ); + + _fnCallbackFire( oSettings, null, 'order', [oSettings, aSort, sortedColumns] ); + _fnSortAria( oSettings ); + } + } ); + } + + _fnCallbackReg( oSettings, 'aoDrawCallback', function () { + if ( oSettings.bSorted || _fnDataSource( oSettings ) === 'ssp' || features.bDeferRender ) { + _fnSortingClasses( oSettings ); + } + }, 'sc' ); + + + /* + * Final init + * Cache the header, body and footer as required, creating them if needed + */ + + // Work around for Webkit bug 83867 - store the caption-side before removing from doc + var captions = $this.children('caption').each( function () { + this._captionSide = $(this).css('caption-side'); + } ); + + var thead = $this.children('thead'); + if ( thead.length === 0 ) { + thead = $('<thead/>').appendTo($this); + } + oSettings.nTHead = thead[0]; + + var tbody = $this.children('tbody'); + if ( tbody.length === 0 ) { + tbody = $('<tbody/>').insertAfter(thead); + } + oSettings.nTBody = tbody[0]; + + var tfoot = $this.children('tfoot'); + if ( tfoot.length === 0 && captions.length > 0 && (oSettings.oScroll.sX !== "" || oSettings.oScroll.sY !== "") ) { + // If we are a scrolling table, and no footer has been given, then we need to create + // a tfoot element for the caption element to be appended to + tfoot = $('<tfoot/>').appendTo($this); + } + + if ( tfoot.length === 0 || tfoot.children().length === 0 ) { + $this.addClass( oClasses.sNoFooter ); + } + else if ( tfoot.length > 0 ) { + oSettings.nTFoot = tfoot[0]; + _fnDetectHeader( oSettings.aoFooter, oSettings.nTFoot ); + } + + /* Check if there is data passing into the constructor */ + if ( oInit.aaData ) { + for ( i=0 ; i<oInit.aaData.length ; i++ ) { + _fnAddData( oSettings, oInit.aaData[ i ] ); + } + } + else if ( oSettings.bDeferLoading || _fnDataSource( oSettings ) == 'dom' ) { + /* Grab the data from the page - only do this when deferred loading or no Ajax + * source since there is no point in reading the DOM data if we are then going + * to replace it with Ajax data + */ + _fnAddTr( oSettings, $(oSettings.nTBody).children('tr') ); + } + + /* Copy the data index array */ + oSettings.aiDisplay = oSettings.aiDisplayMaster.slice(); + + /* Initialisation complete - table can be drawn */ + oSettings.bInitialised = true; + + /* Check if we need to initialise the table (it might not have been handed off to the + * language processor) + */ + if ( bInitHandedOff === false ) { + _fnInitialise( oSettings ); + } + }; + + /* Must be done after everything which can be overridden by the state saving! */ + _fnCallbackReg( oSettings, 'aoDrawCallback', _fnSaveState, 'state_save' ); + + if ( oInit.bStateSave ) + { + features.bStateSave = true; + _fnLoadState( oSettings, oInit, loadedInit ); + } + else { + loadedInit(); + } + + } ); + _that = null; + return this; + }; + + + /* + * It is useful to have variables which are scoped locally so only the + * DataTables functions can access them and they don't leak into global space. + * At the same time these functions are often useful over multiple files in the + * core and API, so we list, or at least document, all variables which are used + * by DataTables as private variables here. This also ensures that there is no + * clashing of variable names and that they can easily referenced for reuse. + */ + + + // Defined else where + // _selector_run + // _selector_opts + // _selector_first + // _selector_row_indexes + + var _ext; // DataTable.ext + var _Api; // DataTable.Api + var _api_register; // DataTable.Api.register + var _api_registerPlural; // DataTable.Api.registerPlural + + var _re_dic = {}; + var _re_new_lines = /[\r\n\u2028]/g; + var _re_html = /<.*?>/g; + + // This is not strict ISO8601 - Date.parse() is quite lax, although + // implementations differ between browsers. + var _re_date = /^\d{2,4}[\.\/\-]\d{1,2}[\.\/\-]\d{1,2}([T ]{1}\d{1,2}[:\.]\d{2}([\.:]\d{2})?)?$/; + + // Escape regular expression special characters + var _re_escape_regex = new RegExp( '(\\' + [ '/', '.', '*', '+', '?', '|', '(', ')', '[', ']', '{', '}', '\\', '$', '^', '-' ].join('|\\') + ')', 'g' ); + + // http://en.wikipedia.org/wiki/Foreign_exchange_market + // - \u20BD - Russian ruble. + // - \u20a9 - South Korean Won + // - \u20BA - Turkish Lira + // - \u20B9 - Indian Rupee + // - R - Brazil (R$) and South Africa + // - fr - Swiss Franc + // - kr - Swedish krona, Norwegian krone and Danish krone + // - \u2009 is thin space and \u202F is narrow no-break space, both used in many + // - Ƀ - Bitcoin + // - Ξ - Ethereum + // standards as thousands separators. + var _re_formatted_numeric = /['\u00A0,$£€¥%\u2009\u202F\u20BD\u20a9\u20BArfkɃΞ]/gi; + + + var _empty = function ( d ) { + return !d || d === true || d === '-' ? true : false; + }; + + + var _intVal = function ( s ) { + var integer = parseInt( s, 10 ); + return !isNaN(integer) && isFinite(s) ? integer : null; + }; + + // Convert from a formatted number with characters other than `.` as the + // decimal place, to a Javascript number + var _numToDecimal = function ( num, decimalPoint ) { + // Cache created regular expressions for speed as this function is called often + if ( ! _re_dic[ decimalPoint ] ) { + _re_dic[ decimalPoint ] = new RegExp( _fnEscapeRegex( decimalPoint ), 'g' ); + } + return typeof num === 'string' && decimalPoint !== '.' ? + num.replace( /\./g, '' ).replace( _re_dic[ decimalPoint ], '.' ) : + num; + }; + + + var _isNumber = function ( d, decimalPoint, formatted ) { + var strType = typeof d === 'string'; + + // If empty return immediately so there must be a number if it is a + // formatted string (this stops the string "k", or "kr", etc being detected + // as a formatted number for currency + if ( _empty( d ) ) { + return true; + } + + if ( decimalPoint && strType ) { + d = _numToDecimal( d, decimalPoint ); + } + + if ( formatted && strType ) { + d = d.replace( _re_formatted_numeric, '' ); + } + + return !isNaN( parseFloat(d) ) && isFinite( d ); + }; + + + // A string without HTML in it can be considered to be HTML still + var _isHtml = function ( d ) { + return _empty( d ) || typeof d === 'string'; + }; + + + var _htmlNumeric = function ( d, decimalPoint, formatted ) { + if ( _empty( d ) ) { + return true; + } + + var html = _isHtml( d ); + return ! html ? + null : + _isNumber( _stripHtml( d ), decimalPoint, formatted ) ? + true : + null; + }; + + + var _pluck = function ( a, prop, prop2 ) { + var out = []; + var i=0, ien=a.length; + + // Could have the test in the loop for slightly smaller code, but speed + // is essential here + if ( prop2 !== undefined ) { + for ( ; i<ien ; i++ ) { + if ( a[i] && a[i][ prop ] ) { + out.push( a[i][ prop ][ prop2 ] ); + } + } + } + else { + for ( ; i<ien ; i++ ) { + if ( a[i] ) { + out.push( a[i][ prop ] ); + } + } + } + + return out; + }; + + + // Basically the same as _pluck, but rather than looping over `a` we use `order` + // as the indexes to pick from `a` + var _pluck_order = function ( a, order, prop, prop2 ) + { + var out = []; + var i=0, ien=order.length; + + // Could have the test in the loop for slightly smaller code, but speed + // is essential here + if ( prop2 !== undefined ) { + for ( ; i<ien ; i++ ) { + if ( a[ order[i] ][ prop ] ) { + out.push( a[ order[i] ][ prop ][ prop2 ] ); + } + } + } + else { + for ( ; i<ien ; i++ ) { + out.push( a[ order[i] ][ prop ] ); + } + } + + return out; + }; + + + var _range = function ( len, start ) + { + var out = []; + var end; + + if ( start === undefined ) { + start = 0; + end = len; + } + else { + end = start; + start = len; + } + + for ( var i=start ; i<end ; i++ ) { + out.push( i ); + } + + return out; + }; + + + var _removeEmpty = function ( a ) + { + var out = []; + + for ( var i=0, ien=a.length ; i<ien ; i++ ) { + if ( a[i] ) { // careful - will remove all falsy values! + out.push( a[i] ); + } + } + + return out; + }; + + + var _stripHtml = function ( d ) { + return d.replace( _re_html, '' ); + }; + + + /** + * Determine if all values in the array are unique. This means we can short + * cut the _unique method at the cost of a single loop. A sorted array is used + * to easily check the values. + * + * @param {array} src Source array + * @return {boolean} true if all unique, false otherwise + * @ignore + */ + var _areAllUnique = function ( src ) { + if ( src.length < 2 ) { + return true; + } + + var sorted = src.slice().sort(); + var last = sorted[0]; + + for ( var i=1, ien=sorted.length ; i<ien ; i++ ) { + if ( sorted[i] === last ) { + return false; + } + + last = sorted[i]; + } + + return true; + }; + + + /** + * Find the unique elements in a source array. + * + * @param {array} src Source array + * @return {array} Array of unique items + * @ignore + */ + var _unique = function ( src ) + { + if ( _areAllUnique( src ) ) { + return src.slice(); + } + + // A faster unique method is to use object keys to identify used values, + // but this doesn't work with arrays or objects, which we must also + // consider. See jsperf.com/compare-array-unique-versions/4 for more + // information. + var + out = [], + val, + i, ien=src.length, + j, k=0; + + again: for ( i=0 ; i<ien ; i++ ) { + val = src[i]; + + for ( j=0 ; j<k ; j++ ) { + if ( out[j] === val ) { + continue again; + } + } + + out.push( val ); + k++; + } + + return out; + }; + + // Surprisingly this is faster than [].concat.apply + // https://jsperf.com/flatten-an-array-loop-vs-reduce/2 + var _flatten = function (out, val) { + if (Array.isArray(val)) { + for (var i=0 ; i<val.length ; i++) { + _flatten(out, val[i]); + } + } + else { + out.push(val); + } + + return out; + } + + var _includes = function (search, start) { + if (start === undefined) { + start = 0; + } + + return this.indexOf(search, start) !== -1; + }; + + // Array.isArray polyfill. + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray + if (! Array.isArray) { + Array.isArray = function(arg) { + return Object.prototype.toString.call(arg) === '[object Array]'; + }; + } + + if (! Array.prototype.includes) { + Array.prototype.includes = _includes; + } + + // .trim() polyfill + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trim + if (!String.prototype.trim) { + String.prototype.trim = function () { + return this.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, ''); + }; + } + + if (! String.prototype.includes) { + String.prototype.includes = _includes; + } + + /** + * DataTables utility methods + * + * This namespace provides helper methods that DataTables uses internally to + * create a DataTable, but which are not exclusively used only for DataTables. + * These methods can be used by extension authors to save the duplication of + * code. + * + * @namespace + */ + DataTable.util = { + /** + * Throttle the calls to a function. Arguments and context are maintained + * for the throttled function. + * + * @param {function} fn Function to be called + * @param {integer} freq Call frequency in mS + * @return {function} Wrapped function + */ + throttle: function ( fn, freq ) { + var + frequency = freq !== undefined ? freq : 200, + last, + timer; + + return function () { + var + that = this, + now = +new Date(), + args = arguments; + + if ( last && now < last + frequency ) { + clearTimeout( timer ); + + timer = setTimeout( function () { + last = undefined; + fn.apply( that, args ); + }, frequency ); + } + else { + last = now; + fn.apply( that, args ); + } + }; + }, + + + /** + * Escape a string such that it can be used in a regular expression + * + * @param {string} val string to escape + * @returns {string} escaped string + */ + escapeRegex: function ( val ) { + return val.replace( _re_escape_regex, '\\$1' ); + }, + + /** + * Create a function that will write to a nested object or array + * @param {*} source JSON notation string + * @returns Write function + */ + set: function ( source ) { + if ( $.isPlainObject( source ) ) { + /* Unlike get, only the underscore (global) option is used for for + * setting data since we don't know the type here. This is why an object + * option is not documented for `mData` (which is read/write), but it is + * for `mRender` which is read only. + */ + return DataTable.util.set( source._ ); + } + else if ( source === null ) { + // Nothing to do when the data source is null + return function () {}; + } + else if ( typeof source === 'function' ) { + return function (data, val, meta) { + source( data, 'set', val, meta ); + }; + } + else if ( typeof source === 'string' && (source.indexOf('.') !== -1 || + source.indexOf('[') !== -1 || source.indexOf('(') !== -1) ) + { + // Like the get, we need to get data from a nested object + var setData = function (data, val, src) { + var a = _fnSplitObjNotation( src ), b; + var aLast = a[a.length-1]; + var arrayNotation, funcNotation, o, innerSrc; + + for ( var i=0, iLen=a.length-1 ; i<iLen ; i++ ) { + // Protect against prototype pollution + if (a[i] === '__proto__' || a[i] === 'constructor') { + throw new Error('Cannot set prototype values'); + } + + // Check if we are dealing with an array notation request + arrayNotation = a[i].match(__reArray); + funcNotation = a[i].match(__reFn); + + if ( arrayNotation ) { + a[i] = a[i].replace(__reArray, ''); + data[ a[i] ] = []; + + // Get the remainder of the nested object to set so we can recurse + b = a.slice(); + b.splice( 0, i+1 ); + innerSrc = b.join('.'); + + // Traverse each entry in the array setting the properties requested + if ( Array.isArray( val ) ) { + for ( var j=0, jLen=val.length ; j<jLen ; j++ ) { + o = {}; + setData( o, val[j], innerSrc ); + data[ a[i] ].push( o ); + } + } + else { + // We've been asked to save data to an array, but it + // isn't array data to be saved. Best that can be done + // is to just save the value. + data[ a[i] ] = val; + } + + // The inner call to setData has already traversed through the remainder + // of the source and has set the data, thus we can exit here + return; + } + else if ( funcNotation ) { + // Function call + a[i] = a[i].replace(__reFn, ''); + data = data[ a[i] ]( val ); + } + + // If the nested object doesn't currently exist - since we are + // trying to set the value - create it + if ( data[ a[i] ] === null || data[ a[i] ] === undefined ) { + data[ a[i] ] = {}; + } + data = data[ a[i] ]; + } + + // Last item in the input - i.e, the actual set + if ( aLast.match(__reFn ) ) { + // Function call + data = data[ aLast.replace(__reFn, '') ]( val ); + } + else { + // If array notation is used, we just want to strip it and use the property name + // and assign the value. If it isn't used, then we get the result we want anyway + data[ aLast.replace(__reArray, '') ] = val; + } + }; + + return function (data, val) { // meta is also passed in, but not used + return setData( data, val, source ); + }; + } + else { + // Array or flat object mapping + return function (data, val) { // meta is also passed in, but not used + data[source] = val; + }; + } + }, + + /** + * Create a function that will read nested objects from arrays, based on JSON notation + * @param {*} source JSON notation string + * @returns Value read + */ + get: function ( source ) { + if ( $.isPlainObject( source ) ) { + // Build an object of get functions, and wrap them in a single call + var o = {}; + $.each( source, function (key, val) { + if ( val ) { + o[key] = DataTable.util.get( val ); + } + } ); + + return function (data, type, row, meta) { + var t = o[type] || o._; + return t !== undefined ? + t(data, type, row, meta) : + data; + }; + } + else if ( source === null ) { + // Give an empty string for rendering / sorting etc + return function (data) { // type, row and meta also passed, but not used + return data; + }; + } + else if ( typeof source === 'function' ) { + return function (data, type, row, meta) { + return source( data, type, row, meta ); + }; + } + else if ( typeof source === 'string' && (source.indexOf('.') !== -1 || + source.indexOf('[') !== -1 || source.indexOf('(') !== -1) ) + { + /* If there is a . in the source string then the data source is in a + * nested object so we loop over the data for each level to get the next + * level down. On each loop we test for undefined, and if found immediately + * return. This allows entire objects to be missing and sDefaultContent to + * be used if defined, rather than throwing an error + */ + var fetchData = function (data, type, src) { + var arrayNotation, funcNotation, out, innerSrc; + + if ( src !== "" ) { + var a = _fnSplitObjNotation( src ); + + for ( var i=0, iLen=a.length ; i<iLen ; i++ ) { + // Check if we are dealing with special notation + arrayNotation = a[i].match(__reArray); + funcNotation = a[i].match(__reFn); + + if ( arrayNotation ) { + // Array notation + a[i] = a[i].replace(__reArray, ''); + + // Condition allows simply [] to be passed in + if ( a[i] !== "" ) { + data = data[ a[i] ]; + } + out = []; + + // Get the remainder of the nested object to get + a.splice( 0, i+1 ); + innerSrc = a.join('.'); + + // Traverse each entry in the array getting the properties requested + if ( Array.isArray( data ) ) { + for ( var j=0, jLen=data.length ; j<jLen ; j++ ) { + out.push( fetchData( data[j], type, innerSrc ) ); + } + } + + // If a string is given in between the array notation indicators, that + // is used to join the strings together, otherwise an array is returned + var join = arrayNotation[0].substring(1, arrayNotation[0].length-1); + data = (join==="") ? out : out.join(join); + + // The inner call to fetchData has already traversed through the remainder + // of the source requested, so we exit from the loop + break; + } + else if ( funcNotation ) { + // Function call + a[i] = a[i].replace(__reFn, ''); + data = data[ a[i] ](); + continue; + } + + if ( data === null || data[ a[i] ] === undefined ) { + return undefined; + } + + data = data[ a[i] ]; + } + } + + return data; + }; + + return function (data, type) { // row and meta also passed, but not used + return fetchData( data, type, source ); + }; + } + else { + // Array or flat object mapping + return function (data, type) { // row and meta also passed, but not used + return data[source]; + }; + } + } + }; + + + + /** + * Create a mapping object that allows camel case parameters to be looked up + * for their Hungarian counterparts. The mapping is stored in a private + * parameter called `_hungarianMap` which can be accessed on the source object. + * @param {object} o + * @memberof DataTable#oApi + */ + function _fnHungarianMap ( o ) + { + var + hungarian = 'a aa ai ao as b fn i m o s ', + match, + newKey, + map = {}; + + $.each( o, function (key, val) { + match = key.match(/^([^A-Z]+?)([A-Z])/); + + if ( match && hungarian.indexOf(match[1]+' ') !== -1 ) + { + newKey = key.replace( match[0], match[2].toLowerCase() ); + map[ newKey ] = key; + + if ( match[1] === 'o' ) + { + _fnHungarianMap( o[key] ); + } + } + } ); + + o._hungarianMap = map; + } + + + /** + * Convert from camel case parameters to Hungarian, based on a Hungarian map + * created by _fnHungarianMap. + * @param {object} src The model object which holds all parameters that can be + * mapped. + * @param {object} user The object to convert from camel case to Hungarian. + * @param {boolean} force When set to `true`, properties which already have a + * Hungarian value in the `user` object will be overwritten. Otherwise they + * won't be. + * @memberof DataTable#oApi + */ + function _fnCamelToHungarian ( src, user, force ) + { + if ( ! src._hungarianMap ) { + _fnHungarianMap( src ); + } + + var hungarianKey; + + $.each( user, function (key, val) { + hungarianKey = src._hungarianMap[ key ]; + + if ( hungarianKey !== undefined && (force || user[hungarianKey] === undefined) ) + { + // For objects, we need to buzz down into the object to copy parameters + if ( hungarianKey.charAt(0) === 'o' ) + { + // Copy the camelCase options over to the hungarian + if ( ! user[ hungarianKey ] ) { + user[ hungarianKey ] = {}; + } + $.extend( true, user[hungarianKey], user[key] ); + + _fnCamelToHungarian( src[hungarianKey], user[hungarianKey], force ); + } + else { + user[hungarianKey] = user[ key ]; + } + } + } ); + } + + + /** + * Language compatibility - when certain options are given, and others aren't, we + * need to duplicate the values over, in order to provide backwards compatibility + * with older language files. + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnLanguageCompat( lang ) + { + // Note the use of the Hungarian notation for the parameters in this method as + // this is called after the mapping of camelCase to Hungarian + var defaults = DataTable.defaults.oLanguage; + + // Default mapping + var defaultDecimal = defaults.sDecimal; + if ( defaultDecimal ) { + _addNumericSort( defaultDecimal ); + } + + if ( lang ) { + var zeroRecords = lang.sZeroRecords; + + // Backwards compatibility - if there is no sEmptyTable given, then use the same as + // sZeroRecords - assuming that is given. + if ( ! lang.sEmptyTable && zeroRecords && + defaults.sEmptyTable === "No data available in table" ) + { + _fnMap( lang, lang, 'sZeroRecords', 'sEmptyTable' ); + } + + // Likewise with loading records + if ( ! lang.sLoadingRecords && zeroRecords && + defaults.sLoadingRecords === "Loading..." ) + { + _fnMap( lang, lang, 'sZeroRecords', 'sLoadingRecords' ); + } + + // Old parameter name of the thousands separator mapped onto the new + if ( lang.sInfoThousands ) { + lang.sThousands = lang.sInfoThousands; + } + + var decimal = lang.sDecimal; + if ( decimal && defaultDecimal !== decimal ) { + _addNumericSort( decimal ); + } + } + } + + + /** + * Map one parameter onto another + * @param {object} o Object to map + * @param {*} knew The new parameter name + * @param {*} old The old parameter name + */ + var _fnCompatMap = function ( o, knew, old ) { + if ( o[ knew ] !== undefined ) { + o[ old ] = o[ knew ]; + } + }; + + + /** + * Provide backwards compatibility for the main DT options. Note that the new + * options are mapped onto the old parameters, so this is an external interface + * change only. + * @param {object} init Object to map + */ + function _fnCompatOpts ( init ) + { + _fnCompatMap( init, 'ordering', 'bSort' ); + _fnCompatMap( init, 'orderMulti', 'bSortMulti' ); + _fnCompatMap( init, 'orderClasses', 'bSortClasses' ); + _fnCompatMap( init, 'orderCellsTop', 'bSortCellsTop' ); + _fnCompatMap( init, 'order', 'aaSorting' ); + _fnCompatMap( init, 'orderFixed', 'aaSortingFixed' ); + _fnCompatMap( init, 'paging', 'bPaginate' ); + _fnCompatMap( init, 'pagingType', 'sPaginationType' ); + _fnCompatMap( init, 'pageLength', 'iDisplayLength' ); + _fnCompatMap( init, 'searching', 'bFilter' ); + + // Boolean initialisation of x-scrolling + if ( typeof init.sScrollX === 'boolean' ) { + init.sScrollX = init.sScrollX ? '100%' : ''; + } + if ( typeof init.scrollX === 'boolean' ) { + init.scrollX = init.scrollX ? '100%' : ''; + } + + // Column search objects are in an array, so it needs to be converted + // element by element + var searchCols = init.aoSearchCols; + + if ( searchCols ) { + for ( var i=0, ien=searchCols.length ; i<ien ; i++ ) { + if ( searchCols[i] ) { + _fnCamelToHungarian( DataTable.models.oSearch, searchCols[i] ); + } + } + } + } + + + /** + * Provide backwards compatibility for column options. Note that the new options + * are mapped onto the old parameters, so this is an external interface change + * only. + * @param {object} init Object to map + */ + function _fnCompatCols ( init ) + { + _fnCompatMap( init, 'orderable', 'bSortable' ); + _fnCompatMap( init, 'orderData', 'aDataSort' ); + _fnCompatMap( init, 'orderSequence', 'asSorting' ); + _fnCompatMap( init, 'orderDataType', 'sortDataType' ); + + // orderData can be given as an integer + var dataSort = init.aDataSort; + if ( typeof dataSort === 'number' && ! Array.isArray( dataSort ) ) { + init.aDataSort = [ dataSort ]; + } + } + + + /** + * Browser feature detection for capabilities, quirks + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnBrowserDetect( settings ) + { + // We don't need to do this every time DataTables is constructed, the values + // calculated are specific to the browser and OS configuration which we + // don't expect to change between initialisations + if ( ! DataTable.__browser ) { + var browser = {}; + DataTable.__browser = browser; + + // Scrolling feature / quirks detection + var n = $('<div/>') + .css( { + position: 'fixed', + top: 0, + left: $(window).scrollLeft()*-1, // allow for scrolling + height: 1, + width: 1, + overflow: 'hidden' + } ) + .append( + $('<div/>') + .css( { + position: 'absolute', + top: 1, + left: 1, + width: 100, + overflow: 'scroll' + } ) + .append( + $('<div/>') + .css( { + width: '100%', + height: 10 + } ) + ) + ) + .appendTo( 'body' ); + + var outer = n.children(); + var inner = outer.children(); + + // Numbers below, in order, are: + // inner.offsetWidth, inner.clientWidth, outer.offsetWidth, outer.clientWidth + // + // IE6 XP: 100 100 100 83 + // IE7 Vista: 100 100 100 83 + // IE 8+ Windows: 83 83 100 83 + // Evergreen Windows: 83 83 100 83 + // Evergreen Mac with scrollbars: 85 85 100 85 + // Evergreen Mac without scrollbars: 100 100 100 100 + + // Get scrollbar width + browser.barWidth = outer[0].offsetWidth - outer[0].clientWidth; + + // IE6/7 will oversize a width 100% element inside a scrolling element, to + // include the width of the scrollbar, while other browsers ensure the inner + // element is contained without forcing scrolling + browser.bScrollOversize = inner[0].offsetWidth === 100 && outer[0].clientWidth !== 100; + + // In rtl text layout, some browsers (most, but not all) will place the + // scrollbar on the left, rather than the right. + browser.bScrollbarLeft = Math.round( inner.offset().left ) !== 1; + + // IE8- don't provide height and width for getBoundingClientRect + browser.bBounding = n[0].getBoundingClientRect().width ? true : false; + + n.remove(); + } + + $.extend( settings.oBrowser, DataTable.__browser ); + settings.oScroll.iBarWidth = DataTable.__browser.barWidth; + } + + + /** + * Array.prototype reduce[Right] method, used for browsers which don't support + * JS 1.6. Done this way to reduce code size, since we iterate either way + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnReduce ( that, fn, init, start, end, inc ) + { + var + i = start, + value, + isSet = false; + + if ( init !== undefined ) { + value = init; + isSet = true; + } + + while ( i !== end ) { + if ( ! that.hasOwnProperty(i) ) { + continue; + } + + value = isSet ? + fn( value, that[i], i, that ) : + that[i]; + + isSet = true; + i += inc; + } + + return value; + } + + /** + * Add a column to the list used for the table with default values + * @param {object} oSettings dataTables settings object + * @param {node} nTh The th element for this column + * @memberof DataTable#oApi + */ + function _fnAddColumn( oSettings, nTh ) + { + // Add column to aoColumns array + var oDefaults = DataTable.defaults.column; + var iCol = oSettings.aoColumns.length; + var oCol = $.extend( {}, DataTable.models.oColumn, oDefaults, { + "nTh": nTh ? nTh : document.createElement('th'), + "sTitle": oDefaults.sTitle ? oDefaults.sTitle : nTh ? nTh.innerHTML : '', + "aDataSort": oDefaults.aDataSort ? oDefaults.aDataSort : [iCol], + "mData": oDefaults.mData ? oDefaults.mData : iCol, + idx: iCol + } ); + oSettings.aoColumns.push( oCol ); + + // Add search object for column specific search. Note that the `searchCols[ iCol ]` + // passed into extend can be undefined. This allows the user to give a default + // with only some of the parameters defined, and also not give a default + var searchCols = oSettings.aoPreSearchCols; + searchCols[ iCol ] = $.extend( {}, DataTable.models.oSearch, searchCols[ iCol ] ); + + // Use the default column options function to initialise classes etc + _fnColumnOptions( oSettings, iCol, $(nTh).data() ); + } + + + /** + * Apply options for a column + * @param {object} oSettings dataTables settings object + * @param {int} iCol column index to consider + * @param {object} oOptions object with sType, bVisible and bSearchable etc + * @memberof DataTable#oApi + */ + function _fnColumnOptions( oSettings, iCol, oOptions ) + { + var oCol = oSettings.aoColumns[ iCol ]; + var oClasses = oSettings.oClasses; + var th = $(oCol.nTh); + + // Try to get width information from the DOM. We can't get it from CSS + // as we'd need to parse the CSS stylesheet. `width` option can override + if ( ! oCol.sWidthOrig ) { + // Width attribute + oCol.sWidthOrig = th.attr('width') || null; + + // Style attribute + var t = (th.attr('style') || '').match(/width:\s*(\d+[pxem%]+)/); + if ( t ) { + oCol.sWidthOrig = t[1]; + } + } + + /* User specified column options */ + if ( oOptions !== undefined && oOptions !== null ) + { + // Backwards compatibility + _fnCompatCols( oOptions ); + + // Map camel case parameters to their Hungarian counterparts + _fnCamelToHungarian( DataTable.defaults.column, oOptions, true ); + + /* Backwards compatibility for mDataProp */ + if ( oOptions.mDataProp !== undefined && !oOptions.mData ) + { + oOptions.mData = oOptions.mDataProp; + } + + if ( oOptions.sType ) + { + oCol._sManualType = oOptions.sType; + } + + // `class` is a reserved word in Javascript, so we need to provide + // the ability to use a valid name for the camel case input + if ( oOptions.className && ! oOptions.sClass ) + { + oOptions.sClass = oOptions.className; + } + if ( oOptions.sClass ) { + th.addClass( oOptions.sClass ); + } + + $.extend( oCol, oOptions ); + _fnMap( oCol, oOptions, "sWidth", "sWidthOrig" ); + + /* iDataSort to be applied (backwards compatibility), but aDataSort will take + * priority if defined + */ + if ( oOptions.iDataSort !== undefined ) + { + oCol.aDataSort = [ oOptions.iDataSort ]; + } + _fnMap( oCol, oOptions, "aDataSort" ); + } + + /* Cache the data get and set functions for speed */ + var mDataSrc = oCol.mData; + var mData = _fnGetObjectDataFn( mDataSrc ); + var mRender = oCol.mRender ? _fnGetObjectDataFn( oCol.mRender ) : null; + + var attrTest = function( src ) { + return typeof src === 'string' && src.indexOf('@') !== -1; + }; + oCol._bAttrSrc = $.isPlainObject( mDataSrc ) && ( + attrTest(mDataSrc.sort) || attrTest(mDataSrc.type) || attrTest(mDataSrc.filter) + ); + oCol._setter = null; + + oCol.fnGetData = function (rowData, type, meta) { + var innerData = mData( rowData, type, undefined, meta ); + + return mRender && type ? + mRender( innerData, type, rowData, meta ) : + innerData; + }; + oCol.fnSetData = function ( rowData, val, meta ) { + return _fnSetObjectDataFn( mDataSrc )( rowData, val, meta ); + }; + + // Indicate if DataTables should read DOM data as an object or array + // Used in _fnGetRowElements + if ( typeof mDataSrc !== 'number' ) { + oSettings._rowReadObject = true; + } + + /* Feature sorting overrides column specific when off */ + if ( !oSettings.oFeatures.bSort ) + { + oCol.bSortable = false; + th.addClass( oClasses.sSortableNone ); // Have to add class here as order event isn't called + } + + /* Check that the class assignment is correct for sorting */ + var bAsc = $.inArray('asc', oCol.asSorting) !== -1; + var bDesc = $.inArray('desc', oCol.asSorting) !== -1; + if ( !oCol.bSortable || (!bAsc && !bDesc) ) + { + oCol.sSortingClass = oClasses.sSortableNone; + oCol.sSortingClassJUI = ""; + } + else if ( bAsc && !bDesc ) + { + oCol.sSortingClass = oClasses.sSortableAsc; + oCol.sSortingClassJUI = oClasses.sSortJUIAscAllowed; + } + else if ( !bAsc && bDesc ) + { + oCol.sSortingClass = oClasses.sSortableDesc; + oCol.sSortingClassJUI = oClasses.sSortJUIDescAllowed; + } + else + { + oCol.sSortingClass = oClasses.sSortable; + oCol.sSortingClassJUI = oClasses.sSortJUI; + } + } + + + /** + * Adjust the table column widths for new data. Note: you would probably want to + * do a redraw after calling this function! + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnAdjustColumnSizing ( settings ) + { + /* Not interested in doing column width calculation if auto-width is disabled */ + if ( settings.oFeatures.bAutoWidth !== false ) + { + var columns = settings.aoColumns; + + _fnCalculateColumnWidths( settings ); + for ( var i=0 , iLen=columns.length ; i<iLen ; i++ ) + { + columns[i].nTh.style.width = columns[i].sWidth; + } + } + + var scroll = settings.oScroll; + if ( scroll.sY !== '' || scroll.sX !== '') + { + _fnScrollDraw( settings ); + } + + _fnCallbackFire( settings, null, 'column-sizing', [settings] ); + } + + + /** + * Convert the index of a visible column to the index in the data array (take account + * of hidden columns) + * @param {object} oSettings dataTables settings object + * @param {int} iMatch Visible column index to lookup + * @returns {int} i the data index + * @memberof DataTable#oApi + */ + function _fnVisibleToColumnIndex( oSettings, iMatch ) + { + var aiVis = _fnGetColumns( oSettings, 'bVisible' ); + + return typeof aiVis[iMatch] === 'number' ? + aiVis[iMatch] : + null; + } + + + /** + * Convert the index of an index in the data array and convert it to the visible + * column index (take account of hidden columns) + * @param {int} iMatch Column index to lookup + * @param {object} oSettings dataTables settings object + * @returns {int} i the data index + * @memberof DataTable#oApi + */ + function _fnColumnIndexToVisible( oSettings, iMatch ) + { + var aiVis = _fnGetColumns( oSettings, 'bVisible' ); + var iPos = $.inArray( iMatch, aiVis ); + + return iPos !== -1 ? iPos : null; + } + + + /** + * Get the number of visible columns + * @param {object} oSettings dataTables settings object + * @returns {int} i the number of visible columns + * @memberof DataTable#oApi + */ + function _fnVisbleColumns( oSettings ) + { + var vis = 0; + + // No reduce in IE8, use a loop for now + $.each( oSettings.aoColumns, function ( i, col ) { + if ( col.bVisible && $(col.nTh).css('display') !== 'none' ) { + vis++; + } + } ); + + return vis; + } + + + /** + * Get an array of column indexes that match a given property + * @param {object} oSettings dataTables settings object + * @param {string} sParam Parameter in aoColumns to look for - typically + * bVisible or bSearchable + * @returns {array} Array of indexes with matched properties + * @memberof DataTable#oApi + */ + function _fnGetColumns( oSettings, sParam ) + { + var a = []; + + $.map( oSettings.aoColumns, function(val, i) { + if ( val[sParam] ) { + a.push( i ); + } + } ); + + return a; + } + + + /** + * Calculate the 'type' of a column + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnColumnTypes ( settings ) + { + var columns = settings.aoColumns; + var data = settings.aoData; + var types = DataTable.ext.type.detect; + var i, ien, j, jen, k, ken; + var col, cell, detectedType, cache; + + // For each column, spin over the + for ( i=0, ien=columns.length ; i<ien ; i++ ) { + col = columns[i]; + cache = []; + + if ( ! col.sType && col._sManualType ) { + col.sType = col._sManualType; + } + else if ( ! col.sType ) { + for ( j=0, jen=types.length ; j<jen ; j++ ) { + for ( k=0, ken=data.length ; k<ken ; k++ ) { + // Use a cache array so we only need to get the type data + // from the formatter once (when using multiple detectors) + if ( cache[k] === undefined ) { + cache[k] = _fnGetCellData( settings, k, i, 'type' ); + } + + detectedType = types[j]( cache[k], settings ); + + // If null, then this type can't apply to this column, so + // rather than testing all cells, break out. There is an + // exception for the last type which is `html`. We need to + // scan all rows since it is possible to mix string and HTML + // types + if ( ! detectedType && j !== types.length-1 ) { + break; + } + + // Only a single match is needed for html type since it is + // bottom of the pile and very similar to string - but it + // must not be empty + if ( detectedType === 'html' && ! _empty(cache[k]) ) { + break; + } + } + + // Type is valid for all data points in the column - use this + // type + if ( detectedType ) { + col.sType = detectedType; + break; + } + } + + // Fall back - if no type was detected, always use string + if ( ! col.sType ) { + col.sType = 'string'; + } + } + } + } + + + /** + * Take the column definitions and static columns arrays and calculate how + * they relate to column indexes. The callback function will then apply the + * definition found for a column to a suitable configuration object. + * @param {object} oSettings dataTables settings object + * @param {array} aoColDefs The aoColumnDefs array that is to be applied + * @param {array} aoCols The aoColumns array that defines columns individually + * @param {function} fn Callback function - takes two parameters, the calculated + * column index and the definition for that column. + * @memberof DataTable#oApi + */ + function _fnApplyColumnDefs( oSettings, aoColDefs, aoCols, fn ) + { + var i, iLen, j, jLen, k, kLen, def; + var columns = oSettings.aoColumns; + + // Column definitions with aTargets + if ( aoColDefs ) + { + /* Loop over the definitions array - loop in reverse so first instance has priority */ + for ( i=aoColDefs.length-1 ; i>=0 ; i-- ) + { + def = aoColDefs[i]; + + /* Each definition can target multiple columns, as it is an array */ + var aTargets = def.targets !== undefined ? + def.targets : + def.aTargets; + + if ( ! Array.isArray( aTargets ) ) + { + aTargets = [ aTargets ]; + } + + for ( j=0, jLen=aTargets.length ; j<jLen ; j++ ) + { + if ( typeof aTargets[j] === 'number' && aTargets[j] >= 0 ) + { + /* Add columns that we don't yet know about */ + while( columns.length <= aTargets[j] ) + { + _fnAddColumn( oSettings ); + } + + /* Integer, basic index */ + fn( aTargets[j], def ); + } + else if ( typeof aTargets[j] === 'number' && aTargets[j] < 0 ) + { + /* Negative integer, right to left column counting */ + fn( columns.length+aTargets[j], def ); + } + else if ( typeof aTargets[j] === 'string' ) + { + /* Class name matching on TH element */ + for ( k=0, kLen=columns.length ; k<kLen ; k++ ) + { + if ( aTargets[j] == "_all" || + $(columns[k].nTh).hasClass( aTargets[j] ) ) + { + fn( k, def ); + } + } + } + } + } + } + + // Statically defined columns array + if ( aoCols ) + { + for ( i=0, iLen=aoCols.length ; i<iLen ; i++ ) + { + fn( i, aoCols[i] ); + } + } + } + + /** + * Add a data array to the table, creating DOM node etc. This is the parallel to + * _fnGatherData, but for adding rows from a Javascript source, rather than a + * DOM source. + * @param {object} oSettings dataTables settings object + * @param {array} aData data array to be added + * @param {node} [nTr] TR element to add to the table - optional. If not given, + * DataTables will create a row automatically + * @param {array} [anTds] Array of TD|TH elements for the row - must be given + * if nTr is. + * @returns {int} >=0 if successful (index of new aoData entry), -1 if failed + * @memberof DataTable#oApi + */ + function _fnAddData ( oSettings, aDataIn, nTr, anTds ) + { + /* Create the object for storing information about this new row */ + var iRow = oSettings.aoData.length; + var oData = $.extend( true, {}, DataTable.models.oRow, { + src: nTr ? 'dom' : 'data', + idx: iRow + } ); + + oData._aData = aDataIn; + oSettings.aoData.push( oData ); + + /* Create the cells */ + var nTd, sThisType; + var columns = oSettings.aoColumns; + + // Invalidate the column types as the new data needs to be revalidated + for ( var i=0, iLen=columns.length ; i<iLen ; i++ ) + { + columns[i].sType = null; + } + + /* Add to the display array */ + oSettings.aiDisplayMaster.push( iRow ); + + var id = oSettings.rowIdFn( aDataIn ); + if ( id !== undefined ) { + oSettings.aIds[ id ] = oData; + } + + /* Create the DOM information, or register it if already present */ + if ( nTr || ! oSettings.oFeatures.bDeferRender ) + { + _fnCreateTr( oSettings, iRow, nTr, anTds ); + } + + return iRow; + } + + + /** + * Add one or more TR elements to the table. Generally we'd expect to + * use this for reading data from a DOM sourced table, but it could be + * used for an TR element. Note that if a TR is given, it is used (i.e. + * it is not cloned). + * @param {object} settings dataTables settings object + * @param {array|node|jQuery} trs The TR element(s) to add to the table + * @returns {array} Array of indexes for the added rows + * @memberof DataTable#oApi + */ + function _fnAddTr( settings, trs ) + { + var row; + + // Allow an individual node to be passed in + if ( ! (trs instanceof $) ) { + trs = $(trs); + } + + return trs.map( function (i, el) { + row = _fnGetRowElements( settings, el ); + return _fnAddData( settings, row.data, el, row.cells ); + } ); + } + + + /** + * Take a TR element and convert it to an index in aoData + * @param {object} oSettings dataTables settings object + * @param {node} n the TR element to find + * @returns {int} index if the node is found, null if not + * @memberof DataTable#oApi + */ + function _fnNodeToDataIndex( oSettings, n ) + { + return (n._DT_RowIndex!==undefined) ? n._DT_RowIndex : null; + } + + + /** + * Take a TD element and convert it into a column data index (not the visible index) + * @param {object} oSettings dataTables settings object + * @param {int} iRow The row number the TD/TH can be found in + * @param {node} n The TD/TH element to find + * @returns {int} index if the node is found, -1 if not + * @memberof DataTable#oApi + */ + function _fnNodeToColumnIndex( oSettings, iRow, n ) + { + return $.inArray( n, oSettings.aoData[ iRow ].anCells ); + } + + + /** + * Get the data for a given cell from the internal cache, taking into account data mapping + * @param {object} settings dataTables settings object + * @param {int} rowIdx aoData row id + * @param {int} colIdx Column index + * @param {string} type data get type ('display', 'type' 'filter|search' 'sort|order') + * @returns {*} Cell data + * @memberof DataTable#oApi + */ + function _fnGetCellData( settings, rowIdx, colIdx, type ) + { + if (type === 'search') { + type = 'filter'; + } + else if (type === 'order') { + type = 'sort'; + } + + var draw = settings.iDraw; + var col = settings.aoColumns[colIdx]; + var rowData = settings.aoData[rowIdx]._aData; + var defaultContent = col.sDefaultContent; + var cellData = col.fnGetData( rowData, type, { + settings: settings, + row: rowIdx, + col: colIdx + } ); + + if ( cellData === undefined ) { + if ( settings.iDrawError != draw && defaultContent === null ) { + _fnLog( settings, 0, "Requested unknown parameter "+ + (typeof col.mData=='function' ? '{function}' : "'"+col.mData+"'")+ + " for row "+rowIdx+", column "+colIdx, 4 ); + settings.iDrawError = draw; + } + return defaultContent; + } + + // When the data source is null and a specific data type is requested (i.e. + // not the original data), we can use default column data + if ( (cellData === rowData || cellData === null) && defaultContent !== null && type !== undefined ) { + cellData = defaultContent; + } + else if ( typeof cellData === 'function' ) { + // If the data source is a function, then we run it and use the return, + // executing in the scope of the data object (for instances) + return cellData.call( rowData ); + } + + if ( cellData === null && type === 'display' ) { + return ''; + } + + if ( type === 'filter' ) { + var fomatters = DataTable.ext.type.search; + + if ( fomatters[ col.sType ] ) { + cellData = fomatters[ col.sType ]( cellData ); + } + } + + return cellData; + } + + + /** + * Set the value for a specific cell, into the internal data cache + * @param {object} settings dataTables settings object + * @param {int} rowIdx aoData row id + * @param {int} colIdx Column index + * @param {*} val Value to set + * @memberof DataTable#oApi + */ + function _fnSetCellData( settings, rowIdx, colIdx, val ) + { + var col = settings.aoColumns[colIdx]; + var rowData = settings.aoData[rowIdx]._aData; + + col.fnSetData( rowData, val, { + settings: settings, + row: rowIdx, + col: colIdx + } ); + } + + + // Private variable that is used to match action syntax in the data property object + var __reArray = /\[.*?\]$/; + var __reFn = /\(\)$/; + + /** + * Split string on periods, taking into account escaped periods + * @param {string} str String to split + * @return {array} Split string + */ + function _fnSplitObjNotation( str ) + { + return $.map( str.match(/(\\.|[^\.])+/g) || [''], function ( s ) { + return s.replace(/\\\./g, '.'); + } ); + } + + + /** + * Return a function that can be used to get data from a source object, taking + * into account the ability to use nested objects as a source + * @param {string|int|function} mSource The data source for the object + * @returns {function} Data get function + * @memberof DataTable#oApi + */ + var _fnGetObjectDataFn = DataTable.util.get; + + + /** + * Return a function that can be used to set data from a source object, taking + * into account the ability to use nested objects as a source + * @param {string|int|function} mSource The data source for the object + * @returns {function} Data set function + * @memberof DataTable#oApi + */ + var _fnSetObjectDataFn = DataTable.util.set; + + + /** + * Return an array with the full table data + * @param {object} oSettings dataTables settings object + * @returns array {array} aData Master data array + * @memberof DataTable#oApi + */ + function _fnGetDataMaster ( settings ) + { + return _pluck( settings.aoData, '_aData' ); + } + + + /** + * Nuke the table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnClearTable( settings ) + { + settings.aoData.length = 0; + settings.aiDisplayMaster.length = 0; + settings.aiDisplay.length = 0; + settings.aIds = {}; + } + + + /** + * Take an array of integers (index array) and remove a target integer (value - not + * the key!) + * @param {array} a Index array to target + * @param {int} iTarget value to find + * @memberof DataTable#oApi + */ + function _fnDeleteIndex( a, iTarget, splice ) + { + var iTargetIndex = -1; + + for ( var i=0, iLen=a.length ; i<iLen ; i++ ) + { + if ( a[i] == iTarget ) + { + iTargetIndex = i; + } + else if ( a[i] > iTarget ) + { + a[i]--; + } + } + + if ( iTargetIndex != -1 && splice === undefined ) + { + a.splice( iTargetIndex, 1 ); + } + } + + + /** + * Mark cached data as invalid such that a re-read of the data will occur when + * the cached data is next requested. Also update from the data source object. + * + * @param {object} settings DataTables settings object + * @param {int} rowIdx Row index to invalidate + * @param {string} [src] Source to invalidate from: undefined, 'auto', 'dom' + * or 'data' + * @param {int} [colIdx] Column index to invalidate. If undefined the whole + * row will be invalidated + * @memberof DataTable#oApi + * + * @todo For the modularisation of v1.11 this will need to become a callback, so + * the sort and filter methods can subscribe to it. That will required + * initialisation options for sorting, which is why it is not already baked in + */ + function _fnInvalidate( settings, rowIdx, src, colIdx ) + { + var row = settings.aoData[ rowIdx ]; + var i, ien; + var cellWrite = function ( cell, col ) { + // This is very frustrating, but in IE if you just write directly + // to innerHTML, and elements that are overwritten are GC'ed, + // even if there is a reference to them elsewhere + while ( cell.childNodes.length ) { + cell.removeChild( cell.firstChild ); + } + + cell.innerHTML = _fnGetCellData( settings, rowIdx, col, 'display' ); + }; + + // Are we reading last data from DOM or the data object? + if ( src === 'dom' || ((! src || src === 'auto') && row.src === 'dom') ) { + // Read the data from the DOM + row._aData = _fnGetRowElements( + settings, row, colIdx, colIdx === undefined ? undefined : row._aData + ) + .data; + } + else { + // Reading from data object, update the DOM + var cells = row.anCells; + + if ( cells ) { + if ( colIdx !== undefined ) { + cellWrite( cells[colIdx], colIdx ); + } + else { + for ( i=0, ien=cells.length ; i<ien ; i++ ) { + cellWrite( cells[i], i ); + } + } + } + } + + // For both row and cell invalidation, the cached data for sorting and + // filtering is nulled out + row._aSortData = null; + row._aFilterData = null; + + // Invalidate the type for a specific column (if given) or all columns since + // the data might have changed + var cols = settings.aoColumns; + if ( colIdx !== undefined ) { + cols[ colIdx ].sType = null; + } + else { + for ( i=0, ien=cols.length ; i<ien ; i++ ) { + cols[i].sType = null; + } + + // Update DataTables special `DT_*` attributes for the row + _fnRowAttributes( settings, row ); + } + } + + + /** + * Build a data source object from an HTML row, reading the contents of the + * cells that are in the row. + * + * @param {object} settings DataTables settings object + * @param {node|object} TR element from which to read data or existing row + * object from which to re-read the data from the cells + * @param {int} [colIdx] Optional column index + * @param {array|object} [d] Data source object. If `colIdx` is given then this + * parameter should also be given and will be used to write the data into. + * Only the column in question will be written + * @returns {object} Object with two parameters: `data` the data read, in + * document order, and `cells` and array of nodes (they can be useful to the + * caller, so rather than needing a second traversal to get them, just return + * them from here). + * @memberof DataTable#oApi + */ + function _fnGetRowElements( settings, row, colIdx, d ) + { + var + tds = [], + td = row.firstChild, + name, col, o, i=0, contents, + columns = settings.aoColumns, + objectRead = settings._rowReadObject; + + // Allow the data object to be passed in, or construct + d = d !== undefined ? + d : + objectRead ? + {} : + []; + + var attr = function ( str, td ) { + if ( typeof str === 'string' ) { + var idx = str.indexOf('@'); + + if ( idx !== -1 ) { + var attr = str.substring( idx+1 ); + var setter = _fnSetObjectDataFn( str ); + setter( d, td.getAttribute( attr ) ); + } + } + }; + + // Read data from a cell and store into the data object + var cellProcess = function ( cell ) { + if ( colIdx === undefined || colIdx === i ) { + col = columns[i]; + contents = (cell.innerHTML).trim(); + + if ( col && col._bAttrSrc ) { + var setter = _fnSetObjectDataFn( col.mData._ ); + setter( d, contents ); + + attr( col.mData.sort, cell ); + attr( col.mData.type, cell ); + attr( col.mData.filter, cell ); + } + else { + // Depending on the `data` option for the columns the data can + // be read to either an object or an array. + if ( objectRead ) { + if ( ! col._setter ) { + // Cache the setter function + col._setter = _fnSetObjectDataFn( col.mData ); + } + col._setter( d, contents ); + } + else { + d[i] = contents; + } + } + } + + i++; + }; + + if ( td ) { + // `tr` element was passed in + while ( td ) { + name = td.nodeName.toUpperCase(); + + if ( name == "TD" || name == "TH" ) { + cellProcess( td ); + tds.push( td ); + } + + td = td.nextSibling; + } + } + else { + // Existing row object passed in + tds = row.anCells; + + for ( var j=0, jen=tds.length ; j<jen ; j++ ) { + cellProcess( tds[j] ); + } + } + + // Read the ID from the DOM if present + var rowNode = row.firstChild ? row : row.nTr; + + if ( rowNode ) { + var id = rowNode.getAttribute( 'id' ); + + if ( id ) { + _fnSetObjectDataFn( settings.rowId )( d, id ); + } + } + + return { + data: d, + cells: tds + }; + } + /** + * Create a new TR element (and it's TD children) for a row + * @param {object} oSettings dataTables settings object + * @param {int} iRow Row to consider + * @param {node} [nTrIn] TR element to add to the table - optional. If not given, + * DataTables will create a row automatically + * @param {array} [anTds] Array of TD|TH elements for the row - must be given + * if nTr is. + * @memberof DataTable#oApi + */ + function _fnCreateTr ( oSettings, iRow, nTrIn, anTds ) + { + var + row = oSettings.aoData[iRow], + rowData = row._aData, + cells = [], + nTr, nTd, oCol, + i, iLen, create; + + if ( row.nTr === null ) + { + nTr = nTrIn || document.createElement('tr'); + + row.nTr = nTr; + row.anCells = cells; + + /* Use a private property on the node to allow reserve mapping from the node + * to the aoData array for fast look up + */ + nTr._DT_RowIndex = iRow; + + /* Special parameters can be given by the data source to be used on the row */ + _fnRowAttributes( oSettings, row ); + + /* Process each column */ + for ( i=0, iLen=oSettings.aoColumns.length ; i<iLen ; i++ ) + { + oCol = oSettings.aoColumns[i]; + create = nTrIn ? false : true; + + nTd = create ? document.createElement( oCol.sCellType ) : anTds[i]; + nTd._DT_CellIndex = { + row: iRow, + column: i + }; + + cells.push( nTd ); + + // Need to create the HTML if new, or if a rendering function is defined + if ( create || ((oCol.mRender || oCol.mData !== i) && + (!$.isPlainObject(oCol.mData) || oCol.mData._ !== i+'.display') + )) { + nTd.innerHTML = _fnGetCellData( oSettings, iRow, i, 'display' ); + } + + /* Add user defined class */ + if ( oCol.sClass ) + { + nTd.className += ' '+oCol.sClass; + } + + // Visibility - add or remove as required + if ( oCol.bVisible && ! nTrIn ) + { + nTr.appendChild( nTd ); + } + else if ( ! oCol.bVisible && nTrIn ) + { + nTd.parentNode.removeChild( nTd ); + } + + if ( oCol.fnCreatedCell ) + { + oCol.fnCreatedCell.call( oSettings.oInstance, + nTd, _fnGetCellData( oSettings, iRow, i ), rowData, iRow, i + ); + } + } + + _fnCallbackFire( oSettings, 'aoRowCreatedCallback', null, [nTr, rowData, iRow, cells] ); + } + } + + + /** + * Add attributes to a row based on the special `DT_*` parameters in a data + * source object. + * @param {object} settings DataTables settings object + * @param {object} DataTables row object for the row to be modified + * @memberof DataTable#oApi + */ + function _fnRowAttributes( settings, row ) + { + var tr = row.nTr; + var data = row._aData; + + if ( tr ) { + var id = settings.rowIdFn( data ); + + if ( id ) { + tr.id = id; + } + + if ( data.DT_RowClass ) { + // Remove any classes added by DT_RowClass before + var a = data.DT_RowClass.split(' '); + row.__rowc = row.__rowc ? + _unique( row.__rowc.concat( a ) ) : + a; + + $(tr) + .removeClass( row.__rowc.join(' ') ) + .addClass( data.DT_RowClass ); + } + + if ( data.DT_RowAttr ) { + $(tr).attr( data.DT_RowAttr ); + } + + if ( data.DT_RowData ) { + $(tr).data( data.DT_RowData ); + } + } + } + + + /** + * Create the HTML header for the table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnBuildHead( oSettings ) + { + var i, ien, cell, row, column; + var thead = oSettings.nTHead; + var tfoot = oSettings.nTFoot; + var createHeader = $('th, td', thead).length === 0; + var classes = oSettings.oClasses; + var columns = oSettings.aoColumns; + + if ( createHeader ) { + row = $('<tr/>').appendTo( thead ); + } + + for ( i=0, ien=columns.length ; i<ien ; i++ ) { + column = columns[i]; + cell = $( column.nTh ).addClass( column.sClass ); + + if ( createHeader ) { + cell.appendTo( row ); + } + + // 1.11 move into sorting + if ( oSettings.oFeatures.bSort ) { + cell.addClass( column.sSortingClass ); + + if ( column.bSortable !== false ) { + cell + .attr( 'tabindex', oSettings.iTabIndex ) + .attr( 'aria-controls', oSettings.sTableId ); + + _fnSortAttachListener( oSettings, column.nTh, i ); + } + } + + if ( column.sTitle != cell[0].innerHTML ) { + cell.html( column.sTitle ); + } + + _fnRenderer( oSettings, 'header' )( + oSettings, cell, column, classes + ); + } + + if ( createHeader ) { + _fnDetectHeader( oSettings.aoHeader, thead ); + } + + /* Deal with the footer - add classes if required */ + $(thead).children('tr').children('th, td').addClass( classes.sHeaderTH ); + $(tfoot).children('tr').children('th, td').addClass( classes.sFooterTH ); + + // Cache the footer cells. Note that we only take the cells from the first + // row in the footer. If there is more than one row the user wants to + // interact with, they need to use the table().foot() method. Note also this + // allows cells to be used for multiple columns using colspan + if ( tfoot !== null ) { + var cells = oSettings.aoFooter[0]; + + for ( i=0, ien=cells.length ; i<ien ; i++ ) { + column = columns[i]; + column.nTf = cells[i].cell; + + if ( column.sClass ) { + $(column.nTf).addClass( column.sClass ); + } + } + } + } + + + /** + * Draw the header (or footer) element based on the column visibility states. The + * methodology here is to use the layout array from _fnDetectHeader, modified for + * the instantaneous column visibility, to construct the new layout. The grid is + * traversed over cell at a time in a rows x columns grid fashion, although each + * cell insert can cover multiple elements in the grid - which is tracks using the + * aApplied array. Cell inserts in the grid will only occur where there isn't + * already a cell in that position. + * @param {object} oSettings dataTables settings object + * @param array {objects} aoSource Layout array from _fnDetectHeader + * @param {boolean} [bIncludeHidden=false] If true then include the hidden columns in the calc, + * @memberof DataTable#oApi + */ + function _fnDrawHead( oSettings, aoSource, bIncludeHidden ) + { + var i, iLen, j, jLen, k, kLen, n, nLocalTr; + var aoLocal = []; + var aApplied = []; + var iColumns = oSettings.aoColumns.length; + var iRowspan, iColspan; + + if ( ! aoSource ) + { + return; + } + + if ( bIncludeHidden === undefined ) + { + bIncludeHidden = false; + } + + /* Make a copy of the master layout array, but without the visible columns in it */ + for ( i=0, iLen=aoSource.length ; i<iLen ; i++ ) + { + aoLocal[i] = aoSource[i].slice(); + aoLocal[i].nTr = aoSource[i].nTr; + + /* Remove any columns which are currently hidden */ + for ( j=iColumns-1 ; j>=0 ; j-- ) + { + if ( !oSettings.aoColumns[j].bVisible && !bIncludeHidden ) + { + aoLocal[i].splice( j, 1 ); + } + } + + /* Prep the applied array - it needs an element for each row */ + aApplied.push( [] ); + } + + for ( i=0, iLen=aoLocal.length ; i<iLen ; i++ ) + { + nLocalTr = aoLocal[i].nTr; + + /* All cells are going to be replaced, so empty out the row */ + if ( nLocalTr ) + { + while( (n = nLocalTr.firstChild) ) + { + nLocalTr.removeChild( n ); + } + } + + for ( j=0, jLen=aoLocal[i].length ; j<jLen ; j++ ) + { + iRowspan = 1; + iColspan = 1; + + /* Check to see if there is already a cell (row/colspan) covering our target + * insert point. If there is, then there is nothing to do. + */ + if ( aApplied[i][j] === undefined ) + { + nLocalTr.appendChild( aoLocal[i][j].cell ); + aApplied[i][j] = 1; + + /* Expand the cell to cover as many rows as needed */ + while ( aoLocal[i+iRowspan] !== undefined && + aoLocal[i][j].cell == aoLocal[i+iRowspan][j].cell ) + { + aApplied[i+iRowspan][j] = 1; + iRowspan++; + } + + /* Expand the cell to cover as many columns as needed */ + while ( aoLocal[i][j+iColspan] !== undefined && + aoLocal[i][j].cell == aoLocal[i][j+iColspan].cell ) + { + /* Must update the applied array over the rows for the columns */ + for ( k=0 ; k<iRowspan ; k++ ) + { + aApplied[i+k][j+iColspan] = 1; + } + iColspan++; + } + + /* Do the actual expansion in the DOM */ + $(aoLocal[i][j].cell) + .attr('rowspan', iRowspan) + .attr('colspan', iColspan); + } + } + } + } + + + /** + * Insert the required TR nodes into the table for display + * @param {object} oSettings dataTables settings object + * @param ajaxComplete true after ajax call to complete rendering + * @memberof DataTable#oApi + */ + function _fnDraw( oSettings, ajaxComplete ) + { + // Allow for state saving and a custom start position + _fnStart( oSettings ); + + /* Provide a pre-callback function which can be used to cancel the draw is false is returned */ + var aPreDraw = _fnCallbackFire( oSettings, 'aoPreDrawCallback', 'preDraw', [oSettings] ); + if ( $.inArray( false, aPreDraw ) !== -1 ) + { + _fnProcessingDisplay( oSettings, false ); + return; + } + + var anRows = []; + var iRowCount = 0; + var asStripeClasses = oSettings.asStripeClasses; + var iStripes = asStripeClasses.length; + var oLang = oSettings.oLanguage; + var bServerSide = _fnDataSource( oSettings ) == 'ssp'; + var aiDisplay = oSettings.aiDisplay; + var iDisplayStart = oSettings._iDisplayStart; + var iDisplayEnd = oSettings.fnDisplayEnd(); + + oSettings.bDrawing = true; + + /* Server-side processing draw intercept */ + if ( oSettings.bDeferLoading ) + { + oSettings.bDeferLoading = false; + oSettings.iDraw++; + _fnProcessingDisplay( oSettings, false ); + } + else if ( !bServerSide ) + { + oSettings.iDraw++; + } + else if ( !oSettings.bDestroying && !ajaxComplete) + { + _fnAjaxUpdate( oSettings ); + return; + } + + if ( aiDisplay.length !== 0 ) + { + var iStart = bServerSide ? 0 : iDisplayStart; + var iEnd = bServerSide ? oSettings.aoData.length : iDisplayEnd; + + for ( var j=iStart ; j<iEnd ; j++ ) + { + var iDataIndex = aiDisplay[j]; + var aoData = oSettings.aoData[ iDataIndex ]; + if ( aoData.nTr === null ) + { + _fnCreateTr( oSettings, iDataIndex ); + } + + var nRow = aoData.nTr; + + /* Remove the old striping classes and then add the new one */ + if ( iStripes !== 0 ) + { + var sStripe = asStripeClasses[ iRowCount % iStripes ]; + if ( aoData._sRowStripe != sStripe ) + { + $(nRow).removeClass( aoData._sRowStripe ).addClass( sStripe ); + aoData._sRowStripe = sStripe; + } + } + + // Row callback functions - might want to manipulate the row + // iRowCount and j are not currently documented. Are they at all + // useful? + _fnCallbackFire( oSettings, 'aoRowCallback', null, + [nRow, aoData._aData, iRowCount, j, iDataIndex] ); + + anRows.push( nRow ); + iRowCount++; + } + } + else + { + /* Table is empty - create a row with an empty message in it */ + var sZero = oLang.sZeroRecords; + if ( oSettings.iDraw == 1 && _fnDataSource( oSettings ) == 'ajax' ) + { + sZero = oLang.sLoadingRecords; + } + else if ( oLang.sEmptyTable && oSettings.fnRecordsTotal() === 0 ) + { + sZero = oLang.sEmptyTable; + } + + anRows[ 0 ] = $( '<tr/>', { 'class': iStripes ? asStripeClasses[0] : '' } ) + .append( $('<td />', { + 'valign': 'top', + 'colSpan': _fnVisbleColumns( oSettings ), + 'class': oSettings.oClasses.sRowEmpty + } ).html( sZero ) )[0]; + } + + /* Header and footer callbacks */ + _fnCallbackFire( oSettings, 'aoHeaderCallback', 'header', [ $(oSettings.nTHead).children('tr')[0], + _fnGetDataMaster( oSettings ), iDisplayStart, iDisplayEnd, aiDisplay ] ); + + _fnCallbackFire( oSettings, 'aoFooterCallback', 'footer', [ $(oSettings.nTFoot).children('tr')[0], + _fnGetDataMaster( oSettings ), iDisplayStart, iDisplayEnd, aiDisplay ] ); + + var body = $(oSettings.nTBody); + + body.children().detach(); + body.append( $(anRows) ); + + /* Call all required callback functions for the end of a draw */ + _fnCallbackFire( oSettings, 'aoDrawCallback', 'draw', [oSettings] ); + + /* Draw is complete, sorting and filtering must be as well */ + oSettings.bSorted = false; + oSettings.bFiltered = false; + oSettings.bDrawing = false; + } + + + /** + * Redraw the table - taking account of the various features which are enabled + * @param {object} oSettings dataTables settings object + * @param {boolean} [holdPosition] Keep the current paging position. By default + * the paging is reset to the first page + * @memberof DataTable#oApi + */ + function _fnReDraw( settings, holdPosition ) + { + var + features = settings.oFeatures, + sort = features.bSort, + filter = features.bFilter; + + if ( sort ) { + _fnSort( settings ); + } + + if ( filter ) { + _fnFilterComplete( settings, settings.oPreviousSearch ); + } + else { + // No filtering, so we want to just use the display master + settings.aiDisplay = settings.aiDisplayMaster.slice(); + } + + if ( holdPosition !== true ) { + settings._iDisplayStart = 0; + } + + // Let any modules know about the draw hold position state (used by + // scrolling internally) + settings._drawHold = holdPosition; + + _fnDraw( settings ); + + settings._drawHold = false; + } + + + /** + * Add the options to the page HTML for the table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnAddOptionsHtml ( oSettings ) + { + var classes = oSettings.oClasses; + var table = $(oSettings.nTable); + var holding = $('<div/>').insertBefore( table ); // Holding element for speed + var features = oSettings.oFeatures; + + // All DataTables are wrapped in a div + var insert = $('<div/>', { + id: oSettings.sTableId+'_wrapper', + 'class': classes.sWrapper + (oSettings.nTFoot ? '' : ' '+classes.sNoFooter) + } ); + + oSettings.nHolding = holding[0]; + oSettings.nTableWrapper = insert[0]; + oSettings.nTableReinsertBefore = oSettings.nTable.nextSibling; + + /* Loop over the user set positioning and place the elements as needed */ + var aDom = oSettings.sDom.split(''); + var featureNode, cOption, nNewNode, cNext, sAttr, j; + for ( var i=0 ; i<aDom.length ; i++ ) + { + featureNode = null; + cOption = aDom[i]; + + if ( cOption == '<' ) + { + /* New container div */ + nNewNode = $('<div/>')[0]; + + /* Check to see if we should append an id and/or a class name to the container */ + cNext = aDom[i+1]; + if ( cNext == "'" || cNext == '"' ) + { + sAttr = ""; + j = 2; + while ( aDom[i+j] != cNext ) + { + sAttr += aDom[i+j]; + j++; + } + + /* Replace jQuery UI constants @todo depreciated */ + if ( sAttr == "H" ) + { + sAttr = classes.sJUIHeader; + } + else if ( sAttr == "F" ) + { + sAttr = classes.sJUIFooter; + } + + /* The attribute can be in the format of "#id.class", "#id" or "class" This logic + * breaks the string into parts and applies them as needed + */ + if ( sAttr.indexOf('.') != -1 ) + { + var aSplit = sAttr.split('.'); + nNewNode.id = aSplit[0].substr(1, aSplit[0].length-1); + nNewNode.className = aSplit[1]; + } + else if ( sAttr.charAt(0) == "#" ) + { + nNewNode.id = sAttr.substr(1, sAttr.length-1); + } + else + { + nNewNode.className = sAttr; + } + + i += j; /* Move along the position array */ + } + + insert.append( nNewNode ); + insert = $(nNewNode); + } + else if ( cOption == '>' ) + { + /* End container div */ + insert = insert.parent(); + } + // @todo Move options into their own plugins? + else if ( cOption == 'l' && features.bPaginate && features.bLengthChange ) + { + /* Length */ + featureNode = _fnFeatureHtmlLength( oSettings ); + } + else if ( cOption == 'f' && features.bFilter ) + { + /* Filter */ + featureNode = _fnFeatureHtmlFilter( oSettings ); + } + else if ( cOption == 'r' && features.bProcessing ) + { + /* pRocessing */ + featureNode = _fnFeatureHtmlProcessing( oSettings ); + } + else if ( cOption == 't' ) + { + /* Table */ + featureNode = _fnFeatureHtmlTable( oSettings ); + } + else if ( cOption == 'i' && features.bInfo ) + { + /* Info */ + featureNode = _fnFeatureHtmlInfo( oSettings ); + } + else if ( cOption == 'p' && features.bPaginate ) + { + /* Pagination */ + featureNode = _fnFeatureHtmlPaginate( oSettings ); + } + else if ( DataTable.ext.feature.length !== 0 ) + { + /* Plug-in features */ + var aoFeatures = DataTable.ext.feature; + for ( var k=0, kLen=aoFeatures.length ; k<kLen ; k++ ) + { + if ( cOption == aoFeatures[k].cFeature ) + { + featureNode = aoFeatures[k].fnInit( oSettings ); + break; + } + } + } + + /* Add to the 2D features array */ + if ( featureNode ) + { + var aanFeatures = oSettings.aanFeatures; + + if ( ! aanFeatures[cOption] ) + { + aanFeatures[cOption] = []; + } + + aanFeatures[cOption].push( featureNode ); + insert.append( featureNode ); + } + } + + /* Built our DOM structure - replace the holding div with what we want */ + holding.replaceWith( insert ); + oSettings.nHolding = null; + } + + + /** + * Use the DOM source to create up an array of header cells. The idea here is to + * create a layout grid (array) of rows x columns, which contains a reference + * to the cell that that point in the grid (regardless of col/rowspan), such that + * any column / row could be removed and the new grid constructed + * @param array {object} aLayout Array to store the calculated layout in + * @param {node} nThead The header/footer element for the table + * @memberof DataTable#oApi + */ + function _fnDetectHeader ( aLayout, nThead ) + { + var nTrs = $(nThead).children('tr'); + var nTr, nCell; + var i, k, l, iLen, jLen, iColShifted, iColumn, iColspan, iRowspan; + var bUnique; + var fnShiftCol = function ( a, i, j ) { + var k = a[i]; + while ( k[j] ) { + j++; + } + return j; + }; + + aLayout.splice( 0, aLayout.length ); + + /* We know how many rows there are in the layout - so prep it */ + for ( i=0, iLen=nTrs.length ; i<iLen ; i++ ) + { + aLayout.push( [] ); + } + + /* Calculate a layout array */ + for ( i=0, iLen=nTrs.length ; i<iLen ; i++ ) + { + nTr = nTrs[i]; + iColumn = 0; + + /* For every cell in the row... */ + nCell = nTr.firstChild; + while ( nCell ) { + if ( nCell.nodeName.toUpperCase() == "TD" || + nCell.nodeName.toUpperCase() == "TH" ) + { + /* Get the col and rowspan attributes from the DOM and sanitise them */ + iColspan = nCell.getAttribute('colspan') * 1; + iRowspan = nCell.getAttribute('rowspan') * 1; + iColspan = (!iColspan || iColspan===0 || iColspan===1) ? 1 : iColspan; + iRowspan = (!iRowspan || iRowspan===0 || iRowspan===1) ? 1 : iRowspan; + + /* There might be colspan cells already in this row, so shift our target + * accordingly + */ + iColShifted = fnShiftCol( aLayout, i, iColumn ); + + /* Cache calculation for unique columns */ + bUnique = iColspan === 1 ? true : false; + + /* If there is col / rowspan, copy the information into the layout grid */ + for ( l=0 ; l<iColspan ; l++ ) + { + for ( k=0 ; k<iRowspan ; k++ ) + { + aLayout[i+k][iColShifted+l] = { + "cell": nCell, + "unique": bUnique + }; + aLayout[i+k].nTr = nTr; + } + } + } + nCell = nCell.nextSibling; + } + } + } + + + /** + * Get an array of unique th elements, one for each column + * @param {object} oSettings dataTables settings object + * @param {node} nHeader automatically detect the layout from this node - optional + * @param {array} aLayout thead/tfoot layout from _fnDetectHeader - optional + * @returns array {node} aReturn list of unique th's + * @memberof DataTable#oApi + */ + function _fnGetUniqueThs ( oSettings, nHeader, aLayout ) + { + var aReturn = []; + if ( !aLayout ) + { + aLayout = oSettings.aoHeader; + if ( nHeader ) + { + aLayout = []; + _fnDetectHeader( aLayout, nHeader ); + } + } + + for ( var i=0, iLen=aLayout.length ; i<iLen ; i++ ) + { + for ( var j=0, jLen=aLayout[i].length ; j<jLen ; j++ ) + { + if ( aLayout[i][j].unique && + (!aReturn[j] || !oSettings.bSortCellsTop) ) + { + aReturn[j] = aLayout[i][j].cell; + } + } + } + + return aReturn; + } + + /** + * Set the start position for draw + * @param {object} oSettings dataTables settings object + */ + function _fnStart( oSettings ) + { + var bServerSide = _fnDataSource( oSettings ) == 'ssp'; + var iInitDisplayStart = oSettings.iInitDisplayStart; + + // Check and see if we have an initial draw position from state saving + if ( iInitDisplayStart !== undefined && iInitDisplayStart !== -1 ) + { + oSettings._iDisplayStart = bServerSide ? + iInitDisplayStart : + iInitDisplayStart >= oSettings.fnRecordsDisplay() ? + 0 : + iInitDisplayStart; + + oSettings.iInitDisplayStart = -1; + } + } + + /** + * Create an Ajax call based on the table's settings, taking into account that + * parameters can have multiple forms, and backwards compatibility. + * + * @param {object} oSettings dataTables settings object + * @param {array} data Data to send to the server, required by + * DataTables - may be augmented by developer callbacks + * @param {function} fn Callback function to run when data is obtained + */ + function _fnBuildAjax( oSettings, data, fn ) + { + // Compatibility with 1.9-, allow fnServerData and event to manipulate + _fnCallbackFire( oSettings, 'aoServerParams', 'serverParams', [data] ); + + // Convert to object based for 1.10+ if using the old array scheme which can + // come from server-side processing or serverParams + if ( data && Array.isArray(data) ) { + var tmp = {}; + var rbracket = /(.*?)\[\]$/; + + $.each( data, function (key, val) { + var match = val.name.match(rbracket); + + if ( match ) { + // Support for arrays + var name = match[0]; + + if ( ! tmp[ name ] ) { + tmp[ name ] = []; + } + tmp[ name ].push( val.value ); + } + else { + tmp[val.name] = val.value; + } + } ); + data = tmp; + } + + var ajaxData; + var ajax = oSettings.ajax; + var instance = oSettings.oInstance; + var callback = function ( json ) { + var status = oSettings.jqXHR + ? oSettings.jqXHR.status + : null; + + if ( json === null || (typeof status === 'number' && status == 204 ) ) { + json = {}; + _fnAjaxDataSrc( oSettings, json, [] ); + } + + var error = json.error || json.sError; + if ( error ) { + _fnLog( oSettings, 0, error ); + } + + oSettings.json = json; + + _fnCallbackFire( oSettings, null, 'xhr', [oSettings, json, oSettings.jqXHR] ); + fn( json ); + }; + + if ( $.isPlainObject( ajax ) && ajax.data ) + { + ajaxData = ajax.data; + + var newData = typeof ajaxData === 'function' ? + ajaxData( data, oSettings ) : // fn can manipulate data or return + ajaxData; // an object object or array to merge + + // If the function returned something, use that alone + data = typeof ajaxData === 'function' && newData ? + newData : + $.extend( true, data, newData ); + + // Remove the data property as we've resolved it already and don't want + // jQuery to do it again (it is restored at the end of the function) + delete ajax.data; + } + + var baseAjax = { + "data": data, + "success": callback, + "dataType": "json", + "cache": false, + "type": oSettings.sServerMethod, + "error": function (xhr, error, thrown) { + var ret = _fnCallbackFire( oSettings, null, 'xhr', [oSettings, null, oSettings.jqXHR] ); + + if ( $.inArray( true, ret ) === -1 ) { + if ( error == "parsererror" ) { + _fnLog( oSettings, 0, 'Invalid JSON response', 1 ); + } + else if ( xhr.readyState === 4 ) { + _fnLog( oSettings, 0, 'Ajax error', 7 ); + } + } + + _fnProcessingDisplay( oSettings, false ); + } + }; + + // Store the data submitted for the API + oSettings.oAjaxData = data; + + // Allow plug-ins and external processes to modify the data + _fnCallbackFire( oSettings, null, 'preXhr', [oSettings, data] ); + + if ( oSettings.fnServerData ) + { + // DataTables 1.9- compatibility + oSettings.fnServerData.call( instance, + oSettings.sAjaxSource, + $.map( data, function (val, key) { // Need to convert back to 1.9 trad format + return { name: key, value: val }; + } ), + callback, + oSettings + ); + } + else if ( oSettings.sAjaxSource || typeof ajax === 'string' ) + { + // DataTables 1.9- compatibility + oSettings.jqXHR = $.ajax( $.extend( baseAjax, { + url: ajax || oSettings.sAjaxSource + } ) ); + } + else if ( typeof ajax === 'function' ) + { + // Is a function - let the caller define what needs to be done + oSettings.jqXHR = ajax.call( instance, data, callback, oSettings ); + } + else + { + // Object to extend the base settings + oSettings.jqXHR = $.ajax( $.extend( baseAjax, ajax ) ); + + // Restore for next time around + ajax.data = ajaxData; + } + } + + + /** + * Update the table using an Ajax call + * @param {object} settings dataTables settings object + * @returns {boolean} Block the table drawing or not + * @memberof DataTable#oApi + */ + function _fnAjaxUpdate( settings ) + { + settings.iDraw++; + _fnProcessingDisplay( settings, true ); + + _fnBuildAjax( + settings, + _fnAjaxParameters( settings ), + function(json) { + _fnAjaxUpdateDraw( settings, json ); + } + ); + } + + + /** + * Build up the parameters in an object needed for a server-side processing + * request. Note that this is basically done twice, is different ways - a modern + * method which is used by default in DataTables 1.10 which uses objects and + * arrays, or the 1.9- method with is name / value pairs. 1.9 method is used if + * the sAjaxSource option is used in the initialisation, or the legacyAjax + * option is set. + * @param {object} oSettings dataTables settings object + * @returns {bool} block the table drawing or not + * @memberof DataTable#oApi + */ + function _fnAjaxParameters( settings ) + { + var + columns = settings.aoColumns, + columnCount = columns.length, + features = settings.oFeatures, + preSearch = settings.oPreviousSearch, + preColSearch = settings.aoPreSearchCols, + i, data = [], dataProp, column, columnSearch, + sort = _fnSortFlatten( settings ), + displayStart = settings._iDisplayStart, + displayLength = features.bPaginate !== false ? + settings._iDisplayLength : + -1; + + var param = function ( name, value ) { + data.push( { 'name': name, 'value': value } ); + }; + + // DataTables 1.9- compatible method + param( 'sEcho', settings.iDraw ); + param( 'iColumns', columnCount ); + param( 'sColumns', _pluck( columns, 'sName' ).join(',') ); + param( 'iDisplayStart', displayStart ); + param( 'iDisplayLength', displayLength ); + + // DataTables 1.10+ method + var d = { + draw: settings.iDraw, + columns: [], + order: [], + start: displayStart, + length: displayLength, + search: { + value: preSearch.sSearch, + regex: preSearch.bRegex + } + }; + + for ( i=0 ; i<columnCount ; i++ ) { + column = columns[i]; + columnSearch = preColSearch[i]; + dataProp = typeof column.mData=="function" ? 'function' : column.mData ; + + d.columns.push( { + data: dataProp, + name: column.sName, + searchable: column.bSearchable, + orderable: column.bSortable, + search: { + value: columnSearch.sSearch, + regex: columnSearch.bRegex + } + } ); + + param( "mDataProp_"+i, dataProp ); + + if ( features.bFilter ) { + param( 'sSearch_'+i, columnSearch.sSearch ); + param( 'bRegex_'+i, columnSearch.bRegex ); + param( 'bSearchable_'+i, column.bSearchable ); + } + + if ( features.bSort ) { + param( 'bSortable_'+i, column.bSortable ); + } + } + + if ( features.bFilter ) { + param( 'sSearch', preSearch.sSearch ); + param( 'bRegex', preSearch.bRegex ); + } + + if ( features.bSort ) { + $.each( sort, function ( i, val ) { + d.order.push( { column: val.col, dir: val.dir } ); + + param( 'iSortCol_'+i, val.col ); + param( 'sSortDir_'+i, val.dir ); + } ); + + param( 'iSortingCols', sort.length ); + } + + // If the legacy.ajax parameter is null, then we automatically decide which + // form to use, based on sAjaxSource + var legacy = DataTable.ext.legacy.ajax; + if ( legacy === null ) { + return settings.sAjaxSource ? data : d; + } + + // Otherwise, if legacy has been specified then we use that to decide on the + // form + return legacy ? data : d; + } + + + /** + * Data the data from the server (nuking the old) and redraw the table + * @param {object} oSettings dataTables settings object + * @param {object} json json data return from the server. + * @param {string} json.sEcho Tracking flag for DataTables to match requests + * @param {int} json.iTotalRecords Number of records in the data set, not accounting for filtering + * @param {int} json.iTotalDisplayRecords Number of records in the data set, accounting for filtering + * @param {array} json.aaData The data to display on this page + * @param {string} [json.sColumns] Column ordering (sName, comma separated) + * @memberof DataTable#oApi + */ + function _fnAjaxUpdateDraw ( settings, json ) + { + // v1.10 uses camelCase variables, while 1.9 uses Hungarian notation. + // Support both + var compat = function ( old, modern ) { + return json[old] !== undefined ? json[old] : json[modern]; + }; + + var data = _fnAjaxDataSrc( settings, json ); + var draw = compat( 'sEcho', 'draw' ); + var recordsTotal = compat( 'iTotalRecords', 'recordsTotal' ); + var recordsFiltered = compat( 'iTotalDisplayRecords', 'recordsFiltered' ); + + if ( draw !== undefined ) { + // Protect against out of sequence returns + if ( draw*1 < settings.iDraw ) { + return; + } + settings.iDraw = draw * 1; + } + + // No data in returned object, so rather than an array, we show an empty table + if ( ! data ) { + data = []; + } + + _fnClearTable( settings ); + settings._iRecordsTotal = parseInt(recordsTotal, 10); + settings._iRecordsDisplay = parseInt(recordsFiltered, 10); + + for ( var i=0, ien=data.length ; i<ien ; i++ ) { + _fnAddData( settings, data[i] ); + } + settings.aiDisplay = settings.aiDisplayMaster.slice(); + + _fnDraw( settings, true ); + + if ( ! settings._bInitComplete ) { + _fnInitComplete( settings, json ); + } + + _fnProcessingDisplay( settings, false ); + } + + + /** + * Get the data from the JSON data source to use for drawing a table. Using + * `_fnGetObjectDataFn` allows the data to be sourced from a property of the + * source object, or from a processing function. + * @param {object} oSettings dataTables settings object + * @param {object} json Data source object / array from the server + * @return {array} Array of data to use + */ + function _fnAjaxDataSrc ( oSettings, json, write ) + { + var dataSrc = $.isPlainObject( oSettings.ajax ) && oSettings.ajax.dataSrc !== undefined ? + oSettings.ajax.dataSrc : + oSettings.sAjaxDataProp; // Compatibility with 1.9-. + + if ( ! write ) { + if ( dataSrc === 'data' ) { + // If the default, then we still want to support the old style, and safely ignore + // it if possible + return json.aaData || json[dataSrc]; + } + + return dataSrc !== "" ? + _fnGetObjectDataFn( dataSrc )( json ) : + json; + } + + // set + _fnSetObjectDataFn( dataSrc )( json, write ); + } + + /** + * Generate the node required for filtering text + * @returns {node} Filter control element + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlFilter ( settings ) + { + var classes = settings.oClasses; + var tableId = settings.sTableId; + var language = settings.oLanguage; + var previousSearch = settings.oPreviousSearch; + var features = settings.aanFeatures; + var input = '<input type="search" class="'+classes.sFilterInput+'"/>'; + + var str = language.sSearch; + str = str.match(/_INPUT_/) ? + str.replace('_INPUT_', input) : + str+input; + + var filter = $('<div/>', { + 'id': ! features.f ? tableId+'_filter' : null, + 'class': classes.sFilter + } ) + .append( $('<label/>' ).append( str ) ); + + var searchFn = function(event) { + /* Update all other filter input elements for the new display */ + var n = features.f; + var val = !this.value ? "" : this.value; // mental IE8 fix :-( + if(previousSearch.return && event.key !== "Enter") { + return; + } + /* Now do the filter */ + if ( val != previousSearch.sSearch ) { + _fnFilterComplete( settings, { + "sSearch": val, + "bRegex": previousSearch.bRegex, + "bSmart": previousSearch.bSmart , + "bCaseInsensitive": previousSearch.bCaseInsensitive, + "return": previousSearch.return + } ); + + // Need to redraw, without resorting + settings._iDisplayStart = 0; + _fnDraw( settings ); + } + }; + + var searchDelay = settings.searchDelay !== null ? + settings.searchDelay : + _fnDataSource( settings ) === 'ssp' ? + 400 : + 0; + + var jqFilter = $('input', filter) + .val( previousSearch.sSearch ) + .attr( 'placeholder', language.sSearchPlaceholder ) + .on( + 'keyup.DT search.DT input.DT paste.DT cut.DT', + searchDelay ? + _fnThrottle( searchFn, searchDelay ) : + searchFn + ) + .on( 'mouseup', function(e) { + // Edge fix! Edge 17 does not trigger anything other than mouse events when clicking + // on the clear icon (Edge bug 17584515). This is safe in other browsers as `searchFn` + // checks the value to see if it has changed. In other browsers it won't have. + setTimeout( function () { + searchFn.call(jqFilter[0], e); + }, 10); + } ) + .on( 'keypress.DT', function(e) { + /* Prevent form submission */ + if ( e.keyCode == 13 ) { + return false; + } + } ) + .attr('aria-controls', tableId); + + // Update the input elements whenever the table is filtered + $(settings.nTable).on( 'search.dt.DT', function ( ev, s ) { + if ( settings === s ) { + // IE9 throws an 'unknown error' if document.activeElement is used + // inside an iframe or frame... + try { + if ( jqFilter[0] !== document.activeElement ) { + jqFilter.val( previousSearch.sSearch ); + } + } + catch ( e ) {} + } + } ); + + return filter[0]; + } + + + /** + * Filter the table using both the global filter and column based filtering + * @param {object} oSettings dataTables settings object + * @param {object} oSearch search information + * @param {int} [iForce] force a research of the master array (1) or not (undefined or 0) + * @memberof DataTable#oApi + */ + function _fnFilterComplete ( oSettings, oInput, iForce ) + { + var oPrevSearch = oSettings.oPreviousSearch; + var aoPrevSearch = oSettings.aoPreSearchCols; + var fnSaveFilter = function ( oFilter ) { + /* Save the filtering values */ + oPrevSearch.sSearch = oFilter.sSearch; + oPrevSearch.bRegex = oFilter.bRegex; + oPrevSearch.bSmart = oFilter.bSmart; + oPrevSearch.bCaseInsensitive = oFilter.bCaseInsensitive; + oPrevSearch.return = oFilter.return; + }; + var fnRegex = function ( o ) { + // Backwards compatibility with the bEscapeRegex option + return o.bEscapeRegex !== undefined ? !o.bEscapeRegex : o.bRegex; + }; + + // Resolve any column types that are unknown due to addition or invalidation + // @todo As per sort - can this be moved into an event handler? + _fnColumnTypes( oSettings ); + + /* In server-side processing all filtering is done by the server, so no point hanging around here */ + if ( _fnDataSource( oSettings ) != 'ssp' ) + { + /* Global filter */ + _fnFilter( oSettings, oInput.sSearch, iForce, fnRegex(oInput), oInput.bSmart, oInput.bCaseInsensitive, oInput.return ); + fnSaveFilter( oInput ); + + /* Now do the individual column filter */ + for ( var i=0 ; i<aoPrevSearch.length ; i++ ) + { + _fnFilterColumn( oSettings, aoPrevSearch[i].sSearch, i, fnRegex(aoPrevSearch[i]), + aoPrevSearch[i].bSmart, aoPrevSearch[i].bCaseInsensitive ); + } + + /* Custom filtering */ + _fnFilterCustom( oSettings ); + } + else + { + fnSaveFilter( oInput ); + } + + /* Tell the draw function we have been filtering */ + oSettings.bFiltered = true; + _fnCallbackFire( oSettings, null, 'search', [oSettings] ); + } + + + /** + * Apply custom filtering functions + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnFilterCustom( settings ) + { + var filters = DataTable.ext.search; + var displayRows = settings.aiDisplay; + var row, rowIdx; + + for ( var i=0, ien=filters.length ; i<ien ; i++ ) { + var rows = []; + + // Loop over each row and see if it should be included + for ( var j=0, jen=displayRows.length ; j<jen ; j++ ) { + rowIdx = displayRows[ j ]; + row = settings.aoData[ rowIdx ]; + + if ( filters[i]( settings, row._aFilterData, rowIdx, row._aData, j ) ) { + rows.push( rowIdx ); + } + } + + // So the array reference doesn't break set the results into the + // existing array + displayRows.length = 0; + $.merge( displayRows, rows ); + } + } + + + /** + * Filter the table on a per-column basis + * @param {object} oSettings dataTables settings object + * @param {string} sInput string to filter on + * @param {int} iColumn column to filter + * @param {bool} bRegex treat search string as a regular expression or not + * @param {bool} bSmart use smart filtering or not + * @param {bool} bCaseInsensitive Do case insensitive matching or not + * @memberof DataTable#oApi + */ + function _fnFilterColumn ( settings, searchStr, colIdx, regex, smart, caseInsensitive ) + { + if ( searchStr === '' ) { + return; + } + + var data; + var out = []; + var display = settings.aiDisplay; + var rpSearch = _fnFilterCreateSearch( searchStr, regex, smart, caseInsensitive ); + + for ( var i=0 ; i<display.length ; i++ ) { + data = settings.aoData[ display[i] ]._aFilterData[ colIdx ]; + + if ( rpSearch.test( data ) ) { + out.push( display[i] ); + } + } + + settings.aiDisplay = out; + } + + + /** + * Filter the data table based on user input and draw the table + * @param {object} settings dataTables settings object + * @param {string} input string to filter on + * @param {int} force optional - force a research of the master array (1) or not (undefined or 0) + * @param {bool} regex treat as a regular expression or not + * @param {bool} smart perform smart filtering or not + * @param {bool} caseInsensitive Do case insensitive matching or not + * @memberof DataTable#oApi + */ + function _fnFilter( settings, input, force, regex, smart, caseInsensitive ) + { + var rpSearch = _fnFilterCreateSearch( input, regex, smart, caseInsensitive ); + var prevSearch = settings.oPreviousSearch.sSearch; + var displayMaster = settings.aiDisplayMaster; + var display, invalidated, i; + var filtered = []; + + // Need to take account of custom filtering functions - always filter + if ( DataTable.ext.search.length !== 0 ) { + force = true; + } + + // Check if any of the rows were invalidated + invalidated = _fnFilterData( settings ); + + // If the input is blank - we just want the full data set + if ( input.length <= 0 ) { + settings.aiDisplay = displayMaster.slice(); + } + else { + // New search - start from the master array + if ( invalidated || + force || + regex || + prevSearch.length > input.length || + input.indexOf(prevSearch) !== 0 || + settings.bSorted // On resort, the display master needs to be + // re-filtered since indexes will have changed + ) { + settings.aiDisplay = displayMaster.slice(); + } + + // Search the display array + display = settings.aiDisplay; + + for ( i=0 ; i<display.length ; i++ ) { + if ( rpSearch.test( settings.aoData[ display[i] ]._sFilterRow ) ) { + filtered.push( display[i] ); + } + } + + settings.aiDisplay = filtered; + } + } + + + /** + * Build a regular expression object suitable for searching a table + * @param {string} sSearch string to search for + * @param {bool} bRegex treat as a regular expression or not + * @param {bool} bSmart perform smart filtering or not + * @param {bool} bCaseInsensitive Do case insensitive matching or not + * @returns {RegExp} constructed object + * @memberof DataTable#oApi + */ + function _fnFilterCreateSearch( search, regex, smart, caseInsensitive ) + { + search = regex ? + search : + _fnEscapeRegex( search ); + + if ( smart ) { + /* For smart filtering we want to allow the search to work regardless of + * word order. We also want double quoted text to be preserved, so word + * order is important - a la google. So this is what we want to + * generate: + * + * ^(?=.*?\bone\b)(?=.*?\btwo three\b)(?=.*?\bfour\b).*$ + */ + var a = $.map( search.match( /"[^"]+"|[^ ]+/g ) || [''], function ( word ) { + if ( word.charAt(0) === '"' ) { + var m = word.match( /^"(.*)"$/ ); + word = m ? m[1] : word; + } + + return word.replace('"', ''); + } ); + + search = '^(?=.*?'+a.join( ')(?=.*?' )+').*$'; + } + + return new RegExp( search, caseInsensitive ? 'i' : '' ); + } + + + /** + * Escape a string such that it can be used in a regular expression + * @param {string} sVal string to escape + * @returns {string} escaped string + * @memberof DataTable#oApi + */ + var _fnEscapeRegex = DataTable.util.escapeRegex; + + var __filter_div = $('<div>')[0]; + var __filter_div_textContent = __filter_div.textContent !== undefined; + + // Update the filtering data for each row if needed (by invalidation or first run) + function _fnFilterData ( settings ) + { + var columns = settings.aoColumns; + var column; + var i, j, ien, jen, filterData, cellData, row; + var wasInvalidated = false; + + for ( i=0, ien=settings.aoData.length ; i<ien ; i++ ) { + row = settings.aoData[i]; + + if ( ! row._aFilterData ) { + filterData = []; + + for ( j=0, jen=columns.length ; j<jen ; j++ ) { + column = columns[j]; + + if ( column.bSearchable ) { + cellData = _fnGetCellData( settings, i, j, 'filter' ); + + // Search in DataTables 1.10 is string based. In 1.11 this + // should be altered to also allow strict type checking. + if ( cellData === null ) { + cellData = ''; + } + + if ( typeof cellData !== 'string' && cellData.toString ) { + cellData = cellData.toString(); + } + } + else { + cellData = ''; + } + + // If it looks like there is an HTML entity in the string, + // attempt to decode it so sorting works as expected. Note that + // we could use a single line of jQuery to do this, but the DOM + // method used here is much faster http://jsperf.com/html-decode + if ( cellData.indexOf && cellData.indexOf('&') !== -1 ) { + __filter_div.innerHTML = cellData; + cellData = __filter_div_textContent ? + __filter_div.textContent : + __filter_div.innerText; + } + + if ( cellData.replace ) { + cellData = cellData.replace(/[\r\n\u2028]/g, ''); + } + + filterData.push( cellData ); + } + + row._aFilterData = filterData; + row._sFilterRow = filterData.join(' '); + wasInvalidated = true; + } + } + + return wasInvalidated; + } + + + /** + * Convert from the internal Hungarian notation to camelCase for external + * interaction + * @param {object} obj Object to convert + * @returns {object} Inverted object + * @memberof DataTable#oApi + */ + function _fnSearchToCamel ( obj ) + { + return { + search: obj.sSearch, + smart: obj.bSmart, + regex: obj.bRegex, + caseInsensitive: obj.bCaseInsensitive + }; + } + + + + /** + * Convert from camelCase notation to the internal Hungarian. We could use the + * Hungarian convert function here, but this is cleaner + * @param {object} obj Object to convert + * @returns {object} Inverted object + * @memberof DataTable#oApi + */ + function _fnSearchToHung ( obj ) + { + return { + sSearch: obj.search, + bSmart: obj.smart, + bRegex: obj.regex, + bCaseInsensitive: obj.caseInsensitive + }; + } + + /** + * Generate the node required for the info display + * @param {object} oSettings dataTables settings object + * @returns {node} Information element + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlInfo ( settings ) + { + var + tid = settings.sTableId, + nodes = settings.aanFeatures.i, + n = $('<div/>', { + 'class': settings.oClasses.sInfo, + 'id': ! nodes ? tid+'_info' : null + } ); + + if ( ! nodes ) { + // Update display on each draw + settings.aoDrawCallback.push( { + "fn": _fnUpdateInfo, + "sName": "information" + } ); + + n + .attr( 'role', 'status' ) + .attr( 'aria-live', 'polite' ); + + // Table is described by our info div + $(settings.nTable).attr( 'aria-describedby', tid+'_info' ); + } + + return n[0]; + } + + + /** + * Update the information elements in the display + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnUpdateInfo ( settings ) + { + /* Show information about the table */ + var nodes = settings.aanFeatures.i; + if ( nodes.length === 0 ) { + return; + } + + var + lang = settings.oLanguage, + start = settings._iDisplayStart+1, + end = settings.fnDisplayEnd(), + max = settings.fnRecordsTotal(), + total = settings.fnRecordsDisplay(), + out = total ? + lang.sInfo : + lang.sInfoEmpty; + + if ( total !== max ) { + /* Record set after filtering */ + out += ' ' + lang.sInfoFiltered; + } + + // Convert the macros + out += lang.sInfoPostFix; + out = _fnInfoMacros( settings, out ); + + var callback = lang.fnInfoCallback; + if ( callback !== null ) { + out = callback.call( settings.oInstance, + settings, start, end, max, total, out + ); + } + + $(nodes).html( out ); + } + + + function _fnInfoMacros ( settings, str ) + { + // When infinite scrolling, we are always starting at 1. _iDisplayStart is used only + // internally + var + formatter = settings.fnFormatNumber, + start = settings._iDisplayStart+1, + len = settings._iDisplayLength, + vis = settings.fnRecordsDisplay(), + all = len === -1; + + return str. + replace(/_START_/g, formatter.call( settings, start ) ). + replace(/_END_/g, formatter.call( settings, settings.fnDisplayEnd() ) ). + replace(/_MAX_/g, formatter.call( settings, settings.fnRecordsTotal() ) ). + replace(/_TOTAL_/g, formatter.call( settings, vis ) ). + replace(/_PAGE_/g, formatter.call( settings, all ? 1 : Math.ceil( start / len ) ) ). + replace(/_PAGES_/g, formatter.call( settings, all ? 1 : Math.ceil( vis / len ) ) ); + } + + + + /** + * Draw the table for the first time, adding all required features + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnInitialise ( settings ) + { + var i, iLen, iAjaxStart=settings.iInitDisplayStart; + var columns = settings.aoColumns, column; + var features = settings.oFeatures; + var deferLoading = settings.bDeferLoading; // value modified by the draw + + /* Ensure that the table data is fully initialised */ + if ( ! settings.bInitialised ) { + setTimeout( function(){ _fnInitialise( settings ); }, 200 ); + return; + } + + /* Show the display HTML options */ + _fnAddOptionsHtml( settings ); + + /* Build and draw the header / footer for the table */ + _fnBuildHead( settings ); + _fnDrawHead( settings, settings.aoHeader ); + _fnDrawHead( settings, settings.aoFooter ); + + /* Okay to show that something is going on now */ + _fnProcessingDisplay( settings, true ); + + /* Calculate sizes for columns */ + if ( features.bAutoWidth ) { + _fnCalculateColumnWidths( settings ); + } + + for ( i=0, iLen=columns.length ; i<iLen ; i++ ) { + column = columns[i]; + + if ( column.sWidth ) { + column.nTh.style.width = _fnStringToCss( column.sWidth ); + } + } + + _fnCallbackFire( settings, null, 'preInit', [settings] ); + + // If there is default sorting required - let's do it. The sort function + // will do the drawing for us. Otherwise we draw the table regardless of the + // Ajax source - this allows the table to look initialised for Ajax sourcing + // data (show 'loading' message possibly) + _fnReDraw( settings ); + + // Server-side processing init complete is done by _fnAjaxUpdateDraw + var dataSrc = _fnDataSource( settings ); + if ( dataSrc != 'ssp' || deferLoading ) { + // if there is an ajax source load the data + if ( dataSrc == 'ajax' ) { + _fnBuildAjax( settings, [], function(json) { + var aData = _fnAjaxDataSrc( settings, json ); + + // Got the data - add it to the table + for ( i=0 ; i<aData.length ; i++ ) { + _fnAddData( settings, aData[i] ); + } + + // Reset the init display for cookie saving. We've already done + // a filter, and therefore cleared it before. So we need to make + // it appear 'fresh' + settings.iInitDisplayStart = iAjaxStart; + + _fnReDraw( settings ); + + _fnProcessingDisplay( settings, false ); + _fnInitComplete( settings, json ); + }, settings ); + } + else { + _fnProcessingDisplay( settings, false ); + _fnInitComplete( settings ); + } + } + } + + + /** + * Draw the table for the first time, adding all required features + * @param {object} oSettings dataTables settings object + * @param {object} [json] JSON from the server that completed the table, if using Ajax source + * with client-side processing (optional) + * @memberof DataTable#oApi + */ + function _fnInitComplete ( settings, json ) + { + settings._bInitComplete = true; + + // When data was added after the initialisation (data or Ajax) we need to + // calculate the column sizing + if ( json || settings.oInit.aaData ) { + _fnAdjustColumnSizing( settings ); + } + + _fnCallbackFire( settings, null, 'plugin-init', [settings, json] ); + _fnCallbackFire( settings, 'aoInitComplete', 'init', [settings, json] ); + } + + + function _fnLengthChange ( settings, val ) + { + var len = parseInt( val, 10 ); + settings._iDisplayLength = len; + + _fnLengthOverflow( settings ); + + // Fire length change event + _fnCallbackFire( settings, null, 'length', [settings, len] ); + } + + + /** + * Generate the node required for user display length changing + * @param {object} settings dataTables settings object + * @returns {node} Display length feature node + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlLength ( settings ) + { + var + classes = settings.oClasses, + tableId = settings.sTableId, + menu = settings.aLengthMenu, + d2 = Array.isArray( menu[0] ), + lengths = d2 ? menu[0] : menu, + language = d2 ? menu[1] : menu; + + var select = $('<select/>', { + 'name': tableId+'_length', + 'aria-controls': tableId, + 'class': classes.sLengthSelect + } ); + + for ( var i=0, ien=lengths.length ; i<ien ; i++ ) { + select[0][ i ] = new Option( + typeof language[i] === 'number' ? + settings.fnFormatNumber( language[i] ) : + language[i], + lengths[i] + ); + } + + var div = $('<div><label/></div>').addClass( classes.sLength ); + if ( ! settings.aanFeatures.l ) { + div[0].id = tableId+'_length'; + } + + div.children().append( + settings.oLanguage.sLengthMenu.replace( '_MENU_', select[0].outerHTML ) + ); + + // Can't use `select` variable as user might provide their own and the + // reference is broken by the use of outerHTML + $('select', div) + .val( settings._iDisplayLength ) + .on( 'change.DT', function(e) { + _fnLengthChange( settings, $(this).val() ); + _fnDraw( settings ); + } ); + + // Update node value whenever anything changes the table's length + $(settings.nTable).on( 'length.dt.DT', function (e, s, len) { + if ( settings === s ) { + $('select', div).val( len ); + } + } ); + + return div[0]; + } + + + + /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Note that most of the paging logic is done in + * DataTable.ext.pager + */ + + /** + * Generate the node required for default pagination + * @param {object} oSettings dataTables settings object + * @returns {node} Pagination feature node + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlPaginate ( settings ) + { + var + type = settings.sPaginationType, + plugin = DataTable.ext.pager[ type ], + modern = typeof plugin === 'function', + redraw = function( settings ) { + _fnDraw( settings ); + }, + node = $('<div/>').addClass( settings.oClasses.sPaging + type )[0], + features = settings.aanFeatures; + + if ( ! modern ) { + plugin.fnInit( settings, node, redraw ); + } + + /* Add a draw callback for the pagination on first instance, to update the paging display */ + if ( ! features.p ) + { + node.id = settings.sTableId+'_paginate'; + + settings.aoDrawCallback.push( { + "fn": function( settings ) { + if ( modern ) { + var + start = settings._iDisplayStart, + len = settings._iDisplayLength, + visRecords = settings.fnRecordsDisplay(), + all = len === -1, + page = all ? 0 : Math.ceil( start / len ), + pages = all ? 1 : Math.ceil( visRecords / len ), + buttons = plugin(page, pages), + i, ien; + + for ( i=0, ien=features.p.length ; i<ien ; i++ ) { + _fnRenderer( settings, 'pageButton' )( + settings, features.p[i], i, buttons, page, pages + ); + } + } + else { + plugin.fnUpdate( settings, redraw ); + } + }, + "sName": "pagination" + } ); + } + + return node; + } + + + /** + * Alter the display settings to change the page + * @param {object} settings DataTables settings object + * @param {string|int} action Paging action to take: "first", "previous", + * "next" or "last" or page number to jump to (integer) + * @param [bool] redraw Automatically draw the update or not + * @returns {bool} true page has changed, false - no change + * @memberof DataTable#oApi + */ + function _fnPageChange ( settings, action, redraw ) + { + var + start = settings._iDisplayStart, + len = settings._iDisplayLength, + records = settings.fnRecordsDisplay(); + + if ( records === 0 || len === -1 ) + { + start = 0; + } + else if ( typeof action === "number" ) + { + start = action * len; + + if ( start > records ) + { + start = 0; + } + } + else if ( action == "first" ) + { + start = 0; + } + else if ( action == "previous" ) + { + start = len >= 0 ? + start - len : + 0; + + if ( start < 0 ) + { + start = 0; + } + } + else if ( action == "next" ) + { + if ( start + len < records ) + { + start += len; + } + } + else if ( action == "last" ) + { + start = Math.floor( (records-1) / len) * len; + } + else + { + _fnLog( settings, 0, "Unknown paging action: "+action, 5 ); + } + + var changed = settings._iDisplayStart !== start; + settings._iDisplayStart = start; + + if ( changed ) { + _fnCallbackFire( settings, null, 'page', [settings] ); + + if ( redraw ) { + _fnDraw( settings ); + } + } + + return changed; + } + + + + /** + * Generate the node required for the processing node + * @param {object} settings dataTables settings object + * @returns {node} Processing element + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlProcessing ( settings ) + { + return $('<div/>', { + 'id': ! settings.aanFeatures.r ? settings.sTableId+'_processing' : null, + 'class': settings.oClasses.sProcessing + } ) + .html( settings.oLanguage.sProcessing ) + .insertBefore( settings.nTable )[0]; + } + + + /** + * Display or hide the processing indicator + * @param {object} settings dataTables settings object + * @param {bool} show Show the processing indicator (true) or not (false) + * @memberof DataTable#oApi + */ + function _fnProcessingDisplay ( settings, show ) + { + if ( settings.oFeatures.bProcessing ) { + $(settings.aanFeatures.r).css( 'display', show ? 'block' : 'none' ); + } + + _fnCallbackFire( settings, null, 'processing', [settings, show] ); + } + + /** + * Add any control elements for the table - specifically scrolling + * @param {object} settings dataTables settings object + * @returns {node} Node to add to the DOM + * @memberof DataTable#oApi + */ + function _fnFeatureHtmlTable ( settings ) + { + var table = $(settings.nTable); + + // Scrolling from here on in + var scroll = settings.oScroll; + + if ( scroll.sX === '' && scroll.sY === '' ) { + return settings.nTable; + } + + var scrollX = scroll.sX; + var scrollY = scroll.sY; + var classes = settings.oClasses; + var caption = table.children('caption'); + var captionSide = caption.length ? caption[0]._captionSide : null; + var headerClone = $( table[0].cloneNode(false) ); + var footerClone = $( table[0].cloneNode(false) ); + var footer = table.children('tfoot'); + var _div = '<div/>'; + var size = function ( s ) { + return !s ? null : _fnStringToCss( s ); + }; + + if ( ! footer.length ) { + footer = null; + } + + /* + * The HTML structure that we want to generate in this function is: + * div - scroller + * div - scroll head + * div - scroll head inner + * table - scroll head table + * thead - thead + * div - scroll body + * table - table (master table) + * thead - thead clone for sizing + * tbody - tbody + * div - scroll foot + * div - scroll foot inner + * table - scroll foot table + * tfoot - tfoot + */ + var scroller = $( _div, { 'class': classes.sScrollWrapper } ) + .append( + $(_div, { 'class': classes.sScrollHead } ) + .css( { + overflow: 'hidden', + position: 'relative', + border: 0, + width: scrollX ? size(scrollX) : '100%' + } ) + .append( + $(_div, { 'class': classes.sScrollHeadInner } ) + .css( { + 'box-sizing': 'content-box', + width: scroll.sXInner || '100%' + } ) + .append( + headerClone + .removeAttr('id') + .css( 'margin-left', 0 ) + .append( captionSide === 'top' ? caption : null ) + .append( + table.children('thead') + ) + ) + ) + ) + .append( + $(_div, { 'class': classes.sScrollBody } ) + .css( { + position: 'relative', + overflow: 'auto', + width: size( scrollX ) + } ) + .append( table ) + ); + + if ( footer ) { + scroller.append( + $(_div, { 'class': classes.sScrollFoot } ) + .css( { + overflow: 'hidden', + border: 0, + width: scrollX ? size(scrollX) : '100%' + } ) + .append( + $(_div, { 'class': classes.sScrollFootInner } ) + .append( + footerClone + .removeAttr('id') + .css( 'margin-left', 0 ) + .append( captionSide === 'bottom' ? caption : null ) + .append( + table.children('tfoot') + ) + ) + ) + ); + } + + var children = scroller.children(); + var scrollHead = children[0]; + var scrollBody = children[1]; + var scrollFoot = footer ? children[2] : null; + + // When the body is scrolled, then we also want to scroll the headers + if ( scrollX ) { + $(scrollBody).on( 'scroll.DT', function (e) { + var scrollLeft = this.scrollLeft; + + scrollHead.scrollLeft = scrollLeft; + + if ( footer ) { + scrollFoot.scrollLeft = scrollLeft; + } + } ); + } + + $(scrollBody).css('max-height', scrollY); + if (! scroll.bCollapse) { + $(scrollBody).css('height', scrollY); + } + + settings.nScrollHead = scrollHead; + settings.nScrollBody = scrollBody; + settings.nScrollFoot = scrollFoot; + + // On redraw - align columns + settings.aoDrawCallback.push( { + "fn": _fnScrollDraw, + "sName": "scrolling" + } ); + + return scroller[0]; + } + + + + /** + * Update the header, footer and body tables for resizing - i.e. column + * alignment. + * + * Welcome to the most horrible function DataTables. The process that this + * function follows is basically: + * 1. Re-create the table inside the scrolling div + * 2. Take live measurements from the DOM + * 3. Apply the measurements to align the columns + * 4. Clean up + * + * @param {object} settings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnScrollDraw ( settings ) + { + // Given that this is such a monster function, a lot of variables are use + // to try and keep the minimised size as small as possible + var + scroll = settings.oScroll, + scrollX = scroll.sX, + scrollXInner = scroll.sXInner, + scrollY = scroll.sY, + barWidth = scroll.iBarWidth, + divHeader = $(settings.nScrollHead), + divHeaderStyle = divHeader[0].style, + divHeaderInner = divHeader.children('div'), + divHeaderInnerStyle = divHeaderInner[0].style, + divHeaderTable = divHeaderInner.children('table'), + divBodyEl = settings.nScrollBody, + divBody = $(divBodyEl), + divBodyStyle = divBodyEl.style, + divFooter = $(settings.nScrollFoot), + divFooterInner = divFooter.children('div'), + divFooterTable = divFooterInner.children('table'), + header = $(settings.nTHead), + table = $(settings.nTable), + tableEl = table[0], + tableStyle = tableEl.style, + footer = settings.nTFoot ? $(settings.nTFoot) : null, + browser = settings.oBrowser, + ie67 = browser.bScrollOversize, + dtHeaderCells = _pluck( settings.aoColumns, 'nTh' ), + headerTrgEls, footerTrgEls, + headerSrcEls, footerSrcEls, + headerCopy, footerCopy, + headerWidths=[], footerWidths=[], + headerContent=[], footerContent=[], + idx, correction, sanityWidth, + zeroOut = function(nSizer) { + var style = nSizer.style; + style.paddingTop = "0"; + style.paddingBottom = "0"; + style.borderTopWidth = "0"; + style.borderBottomWidth = "0"; + style.height = 0; + }; + + // If the scrollbar visibility has changed from the last draw, we need to + // adjust the column sizes as the table width will have changed to account + // for the scrollbar + var scrollBarVis = divBodyEl.scrollHeight > divBodyEl.clientHeight; + + if ( settings.scrollBarVis !== scrollBarVis && settings.scrollBarVis !== undefined ) { + settings.scrollBarVis = scrollBarVis; + _fnAdjustColumnSizing( settings ); + return; // adjust column sizing will call this function again + } + else { + settings.scrollBarVis = scrollBarVis; + } + + /* + * 1. Re-create the table inside the scrolling div + */ + + // Remove the old minimised thead and tfoot elements in the inner table + table.children('thead, tfoot').remove(); + + if ( footer ) { + footerCopy = footer.clone().prependTo( table ); + footerTrgEls = footer.find('tr'); // the original tfoot is in its own table and must be sized + footerSrcEls = footerCopy.find('tr'); + } + + // Clone the current header and footer elements and then place it into the inner table + headerCopy = header.clone().prependTo( table ); + headerTrgEls = header.find('tr'); // original header is in its own table + headerSrcEls = headerCopy.find('tr'); + headerCopy.find('th, td').removeAttr('tabindex'); + + + /* + * 2. Take live measurements from the DOM - do not alter the DOM itself! + */ + + // Remove old sizing and apply the calculated column widths + // Get the unique column headers in the newly created (cloned) header. We want to apply the + // calculated sizes to this header + if ( ! scrollX ) + { + divBodyStyle.width = '100%'; + divHeader[0].style.width = '100%'; + } + + $.each( _fnGetUniqueThs( settings, headerCopy ), function ( i, el ) { + idx = _fnVisibleToColumnIndex( settings, i ); + el.style.width = settings.aoColumns[idx].sWidth; + } ); + + if ( footer ) { + _fnApplyToChildren( function(n) { + n.style.width = ""; + }, footerSrcEls ); + } + + // Size the table as a whole + sanityWidth = table.outerWidth(); + if ( scrollX === "" ) { + // No x scrolling + tableStyle.width = "100%"; + + // IE7 will make the width of the table when 100% include the scrollbar + // - which is shouldn't. When there is a scrollbar we need to take this + // into account. + if ( ie67 && (table.find('tbody').height() > divBodyEl.offsetHeight || + divBody.css('overflow-y') == "scroll") + ) { + tableStyle.width = _fnStringToCss( table.outerWidth() - barWidth); + } + + // Recalculate the sanity width + sanityWidth = table.outerWidth(); + } + else if ( scrollXInner !== "" ) { + // legacy x scroll inner has been given - use it + tableStyle.width = _fnStringToCss(scrollXInner); + + // Recalculate the sanity width + sanityWidth = table.outerWidth(); + } + + // Hidden header should have zero height, so remove padding and borders. Then + // set the width based on the real headers + + // Apply all styles in one pass + _fnApplyToChildren( zeroOut, headerSrcEls ); + + // Read all widths in next pass + _fnApplyToChildren( function(nSizer) { + var style = window.getComputedStyle ? + window.getComputedStyle(nSizer).width : + _fnStringToCss( $(nSizer).width() ); + + headerContent.push( nSizer.innerHTML ); + headerWidths.push( style ); + }, headerSrcEls ); + + // Apply all widths in final pass + _fnApplyToChildren( function(nToSize, i) { + nToSize.style.width = headerWidths[i]; + }, headerTrgEls ); + + $(headerSrcEls).css('height', 0); + + /* Same again with the footer if we have one */ + if ( footer ) + { + _fnApplyToChildren( zeroOut, footerSrcEls ); + + _fnApplyToChildren( function(nSizer) { + footerContent.push( nSizer.innerHTML ); + footerWidths.push( _fnStringToCss( $(nSizer).css('width') ) ); + }, footerSrcEls ); + + _fnApplyToChildren( function(nToSize, i) { + nToSize.style.width = footerWidths[i]; + }, footerTrgEls ); + + $(footerSrcEls).height(0); + } + + + /* + * 3. Apply the measurements + */ + + // "Hide" the header and footer that we used for the sizing. We need to keep + // the content of the cell so that the width applied to the header and body + // both match, but we want to hide it completely. We want to also fix their + // width to what they currently are + _fnApplyToChildren( function(nSizer, i) { + nSizer.innerHTML = '<div class="dataTables_sizing">'+headerContent[i]+'</div>'; + nSizer.childNodes[0].style.height = "0"; + nSizer.childNodes[0].style.overflow = "hidden"; + nSizer.style.width = headerWidths[i]; + }, headerSrcEls ); + + if ( footer ) + { + _fnApplyToChildren( function(nSizer, i) { + nSizer.innerHTML = '<div class="dataTables_sizing">'+footerContent[i]+'</div>'; + nSizer.childNodes[0].style.height = "0"; + nSizer.childNodes[0].style.overflow = "hidden"; + nSizer.style.width = footerWidths[i]; + }, footerSrcEls ); + } + + // Sanity check that the table is of a sensible width. If not then we are going to get + // misalignment - try to prevent this by not allowing the table to shrink below its min width + if ( Math.round(table.outerWidth()) < Math.round(sanityWidth) ) + { + // The min width depends upon if we have a vertical scrollbar visible or not */ + correction = ((divBodyEl.scrollHeight > divBodyEl.offsetHeight || + divBody.css('overflow-y') == "scroll")) ? + sanityWidth+barWidth : + sanityWidth; + + // IE6/7 are a law unto themselves... + if ( ie67 && (divBodyEl.scrollHeight > + divBodyEl.offsetHeight || divBody.css('overflow-y') == "scroll") + ) { + tableStyle.width = _fnStringToCss( correction-barWidth ); + } + + // And give the user a warning that we've stopped the table getting too small + if ( scrollX === "" || scrollXInner !== "" ) { + _fnLog( settings, 1, 'Possible column misalignment', 6 ); + } + } + else + { + correction = '100%'; + } + + // Apply to the container elements + divBodyStyle.width = _fnStringToCss( correction ); + divHeaderStyle.width = _fnStringToCss( correction ); + + if ( footer ) { + settings.nScrollFoot.style.width = _fnStringToCss( correction ); + } + + + /* + * 4. Clean up + */ + if ( ! scrollY ) { + /* IE7< puts a vertical scrollbar in place (when it shouldn't be) due to subtracting + * the scrollbar height from the visible display, rather than adding it on. We need to + * set the height in order to sort this. Don't want to do it in any other browsers. + */ + if ( ie67 ) { + divBodyStyle.height = _fnStringToCss( tableEl.offsetHeight+barWidth ); + } + } + + /* Finally set the width's of the header and footer tables */ + var iOuterWidth = table.outerWidth(); + divHeaderTable[0].style.width = _fnStringToCss( iOuterWidth ); + divHeaderInnerStyle.width = _fnStringToCss( iOuterWidth ); + + // Figure out if there are scrollbar present - if so then we need a the header and footer to + // provide a bit more space to allow "overflow" scrolling (i.e. past the scrollbar) + var bScrolling = table.height() > divBodyEl.clientHeight || divBody.css('overflow-y') == "scroll"; + var padding = 'padding' + (browser.bScrollbarLeft ? 'Left' : 'Right' ); + divHeaderInnerStyle[ padding ] = bScrolling ? barWidth+"px" : "0px"; + + if ( footer ) { + divFooterTable[0].style.width = _fnStringToCss( iOuterWidth ); + divFooterInner[0].style.width = _fnStringToCss( iOuterWidth ); + divFooterInner[0].style[padding] = bScrolling ? barWidth+"px" : "0px"; + } + + // Correct DOM ordering for colgroup - comes before the thead + table.children('colgroup').insertBefore( table.children('thead') ); + + /* Adjust the position of the header in case we loose the y-scrollbar */ + divBody.trigger('scroll'); + + // If sorting or filtering has occurred, jump the scrolling back to the top + // only if we aren't holding the position + if ( (settings.bSorted || settings.bFiltered) && ! settings._drawHold ) { + divBodyEl.scrollTop = 0; + } + } + + + + /** + * Apply a given function to the display child nodes of an element array (typically + * TD children of TR rows + * @param {function} fn Method to apply to the objects + * @param array {nodes} an1 List of elements to look through for display children + * @param array {nodes} an2 Another list (identical structure to the first) - optional + * @memberof DataTable#oApi + */ + function _fnApplyToChildren( fn, an1, an2 ) + { + var index=0, i=0, iLen=an1.length; + var nNode1, nNode2; + + while ( i < iLen ) { + nNode1 = an1[i].firstChild; + nNode2 = an2 ? an2[i].firstChild : null; + + while ( nNode1 ) { + if ( nNode1.nodeType === 1 ) { + if ( an2 ) { + fn( nNode1, nNode2, index ); + } + else { + fn( nNode1, index ); + } + + index++; + } + + nNode1 = nNode1.nextSibling; + nNode2 = an2 ? nNode2.nextSibling : null; + } + + i++; + } + } + + + + var __re_html_remove = /<.*?>/g; + + + /** + * Calculate the width of columns for the table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnCalculateColumnWidths ( oSettings ) + { + var + table = oSettings.nTable, + columns = oSettings.aoColumns, + scroll = oSettings.oScroll, + scrollY = scroll.sY, + scrollX = scroll.sX, + scrollXInner = scroll.sXInner, + columnCount = columns.length, + visibleColumns = _fnGetColumns( oSettings, 'bVisible' ), + headerCells = $('th', oSettings.nTHead), + tableWidthAttr = table.getAttribute('width'), // from DOM element + tableContainer = table.parentNode, + userInputs = false, + i, column, columnIdx, width, outerWidth, + browser = oSettings.oBrowser, + ie67 = browser.bScrollOversize; + + var styleWidth = table.style.width; + if ( styleWidth && styleWidth.indexOf('%') !== -1 ) { + tableWidthAttr = styleWidth; + } + + /* Convert any user input sizes into pixel sizes */ + for ( i=0 ; i<visibleColumns.length ; i++ ) { + column = columns[ visibleColumns[i] ]; + + if ( column.sWidth !== null ) { + column.sWidth = _fnConvertToWidth( column.sWidthOrig, tableContainer ); + + userInputs = true; + } + } + + /* If the number of columns in the DOM equals the number that we have to + * process in DataTables, then we can use the offsets that are created by + * the web- browser. No custom sizes can be set in order for this to happen, + * nor scrolling used + */ + if ( ie67 || ! userInputs && ! scrollX && ! scrollY && + columnCount == _fnVisbleColumns( oSettings ) && + columnCount == headerCells.length + ) { + for ( i=0 ; i<columnCount ; i++ ) { + var colIdx = _fnVisibleToColumnIndex( oSettings, i ); + + if ( colIdx !== null ) { + columns[ colIdx ].sWidth = _fnStringToCss( headerCells.eq(i).width() ); + } + } + } + else + { + // Otherwise construct a single row, worst case, table with the widest + // node in the data, assign any user defined widths, then insert it into + // the DOM and allow the browser to do all the hard work of calculating + // table widths + var tmpTable = $(table).clone() // don't use cloneNode - IE8 will remove events on the main table + .css( 'visibility', 'hidden' ) + .removeAttr( 'id' ); + + // Clean up the table body + tmpTable.find('tbody tr').remove(); + var tr = $('<tr/>').appendTo( tmpTable.find('tbody') ); + + // Clone the table header and footer - we can't use the header / footer + // from the cloned table, since if scrolling is active, the table's + // real header and footer are contained in different table tags + tmpTable.find('thead, tfoot').remove(); + tmpTable + .append( $(oSettings.nTHead).clone() ) + .append( $(oSettings.nTFoot).clone() ); + + // Remove any assigned widths from the footer (from scrolling) + tmpTable.find('tfoot th, tfoot td').css('width', ''); + + // Apply custom sizing to the cloned header + headerCells = _fnGetUniqueThs( oSettings, tmpTable.find('thead')[0] ); + + for ( i=0 ; i<visibleColumns.length ; i++ ) { + column = columns[ visibleColumns[i] ]; + + headerCells[i].style.width = column.sWidthOrig !== null && column.sWidthOrig !== '' ? + _fnStringToCss( column.sWidthOrig ) : + ''; + + // For scrollX we need to force the column width otherwise the + // browser will collapse it. If this width is smaller than the + // width the column requires, then it will have no effect + if ( column.sWidthOrig && scrollX ) { + $( headerCells[i] ).append( $('<div/>').css( { + width: column.sWidthOrig, + margin: 0, + padding: 0, + border: 0, + height: 1 + } ) ); + } + } + + // Find the widest cell for each column and put it into the table + if ( oSettings.aoData.length ) { + for ( i=0 ; i<visibleColumns.length ; i++ ) { + columnIdx = visibleColumns[i]; + column = columns[ columnIdx ]; + + $( _fnGetWidestNode( oSettings, columnIdx ) ) + .clone( false ) + .append( column.sContentPadding ) + .appendTo( tr ); + } + } + + // Tidy the temporary table - remove name attributes so there aren't + // duplicated in the dom (radio elements for example) + $('[name]', tmpTable).removeAttr('name'); + + // Table has been built, attach to the document so we can work with it. + // A holding element is used, positioned at the top of the container + // with minimal height, so it has no effect on if the container scrolls + // or not. Otherwise it might trigger scrolling when it actually isn't + // needed + var holder = $('<div/>').css( scrollX || scrollY ? + { + position: 'absolute', + top: 0, + left: 0, + height: 1, + right: 0, + overflow: 'hidden' + } : + {} + ) + .append( tmpTable ) + .appendTo( tableContainer ); + + // When scrolling (X or Y) we want to set the width of the table as + // appropriate. However, when not scrolling leave the table width as it + // is. This results in slightly different, but I think correct behaviour + if ( scrollX && scrollXInner ) { + tmpTable.width( scrollXInner ); + } + else if ( scrollX ) { + tmpTable.css( 'width', 'auto' ); + tmpTable.removeAttr('width'); + + // If there is no width attribute or style, then allow the table to + // collapse + if ( tmpTable.width() < tableContainer.clientWidth && tableWidthAttr ) { + tmpTable.width( tableContainer.clientWidth ); + } + } + else if ( scrollY ) { + tmpTable.width( tableContainer.clientWidth ); + } + else if ( tableWidthAttr ) { + tmpTable.width( tableWidthAttr ); + } + + // Get the width of each column in the constructed table - we need to + // know the inner width (so it can be assigned to the other table's + // cells) and the outer width so we can calculate the full width of the + // table. This is safe since DataTables requires a unique cell for each + // column, but if ever a header can span multiple columns, this will + // need to be modified. + var total = 0; + for ( i=0 ; i<visibleColumns.length ; i++ ) { + var cell = $(headerCells[i]); + var border = cell.outerWidth() - cell.width(); + + // Use getBounding... where possible (not IE8-) because it can give + // sub-pixel accuracy, which we then want to round up! + var bounding = browser.bBounding ? + Math.ceil( headerCells[i].getBoundingClientRect().width ) : + cell.outerWidth(); + + // Total is tracked to remove any sub-pixel errors as the outerWidth + // of the table might not equal the total given here (IE!). + total += bounding; + + // Width for each column to use + columns[ visibleColumns[i] ].sWidth = _fnStringToCss( bounding - border ); + } + + table.style.width = _fnStringToCss( total ); + + // Finished with the table - ditch it + holder.remove(); + } + + // If there is a width attr, we want to attach an event listener which + // allows the table sizing to automatically adjust when the window is + // resized. Use the width attr rather than CSS, since we can't know if the + // CSS is a relative value or absolute - DOM read is always px. + if ( tableWidthAttr ) { + table.style.width = _fnStringToCss( tableWidthAttr ); + } + + if ( (tableWidthAttr || scrollX) && ! oSettings._reszEvt ) { + var bindResize = function () { + $(window).on('resize.DT-'+oSettings.sInstance, _fnThrottle( function () { + _fnAdjustColumnSizing( oSettings ); + } ) ); + }; + + // IE6/7 will crash if we bind a resize event handler on page load. + // To be removed in 1.11 which drops IE6/7 support + if ( ie67 ) { + setTimeout( bindResize, 1000 ); + } + else { + bindResize(); + } + + oSettings._reszEvt = true; + } + } + + + /** + * Throttle the calls to a function. Arguments and context are maintained for + * the throttled function + * @param {function} fn Function to be called + * @param {int} [freq=200] call frequency in mS + * @returns {function} wrapped function + * @memberof DataTable#oApi + */ + var _fnThrottle = DataTable.util.throttle; + + + /** + * Convert a CSS unit width to pixels (e.g. 2em) + * @param {string} width width to be converted + * @param {node} parent parent to get the with for (required for relative widths) - optional + * @returns {int} width in pixels + * @memberof DataTable#oApi + */ + function _fnConvertToWidth ( width, parent ) + { + if ( ! width ) { + return 0; + } + + var n = $('<div/>') + .css( 'width', _fnStringToCss( width ) ) + .appendTo( parent || document.body ); + + var val = n[0].offsetWidth; + n.remove(); + + return val; + } + + + /** + * Get the widest node + * @param {object} settings dataTables settings object + * @param {int} colIdx column of interest + * @returns {node} widest table node + * @memberof DataTable#oApi + */ + function _fnGetWidestNode( settings, colIdx ) + { + var idx = _fnGetMaxLenString( settings, colIdx ); + if ( idx < 0 ) { + return null; + } + + var data = settings.aoData[ idx ]; + return ! data.nTr ? // Might not have been created when deferred rendering + $('<td/>').html( _fnGetCellData( settings, idx, colIdx, 'display' ) )[0] : + data.anCells[ colIdx ]; + } + + + /** + * Get the maximum strlen for each data column + * @param {object} settings dataTables settings object + * @param {int} colIdx column of interest + * @returns {string} max string length for each column + * @memberof DataTable#oApi + */ + function _fnGetMaxLenString( settings, colIdx ) + { + var s, max=-1, maxIdx = -1; + + for ( var i=0, ien=settings.aoData.length ; i<ien ; i++ ) { + s = _fnGetCellData( settings, i, colIdx, 'display' )+''; + s = s.replace( __re_html_remove, '' ); + s = s.replace( / /g, ' ' ); + + if ( s.length > max ) { + max = s.length; + maxIdx = i; + } + } + + return maxIdx; + } + + + /** + * Append a CSS unit (only if required) to a string + * @param {string} value to css-ify + * @returns {string} value with css unit + * @memberof DataTable#oApi + */ + function _fnStringToCss( s ) + { + if ( s === null ) { + return '0px'; + } + + if ( typeof s == 'number' ) { + return s < 0 ? + '0px' : + s+'px'; + } + + // Check it has a unit character already + return s.match(/\d$/) ? + s+'px' : + s; + } + + + + function _fnSortFlatten ( settings ) + { + var + i, iLen, k, kLen, + aSort = [], + aiOrig = [], + aoColumns = settings.aoColumns, + aDataSort, iCol, sType, srcCol, + fixed = settings.aaSortingFixed, + fixedObj = $.isPlainObject( fixed ), + nestedSort = [], + add = function ( a ) { + if ( a.length && ! Array.isArray( a[0] ) ) { + // 1D array + nestedSort.push( a ); + } + else { + // 2D array + $.merge( nestedSort, a ); + } + }; + + // Build the sort array, with pre-fix and post-fix options if they have been + // specified + if ( Array.isArray( fixed ) ) { + add( fixed ); + } + + if ( fixedObj && fixed.pre ) { + add( fixed.pre ); + } + + add( settings.aaSorting ); + + if (fixedObj && fixed.post ) { + add( fixed.post ); + } + + for ( i=0 ; i<nestedSort.length ; i++ ) + { + srcCol = nestedSort[i][0]; + aDataSort = aoColumns[ srcCol ].aDataSort; + + for ( k=0, kLen=aDataSort.length ; k<kLen ; k++ ) + { + iCol = aDataSort[k]; + sType = aoColumns[ iCol ].sType || 'string'; + + if ( nestedSort[i]._idx === undefined ) { + nestedSort[i]._idx = $.inArray( nestedSort[i][1], aoColumns[iCol].asSorting ); + } + + aSort.push( { + src: srcCol, + col: iCol, + dir: nestedSort[i][1], + index: nestedSort[i]._idx, + type: sType, + formatter: DataTable.ext.type.order[ sType+"-pre" ] + } ); + } + } + + return aSort; + } + + /** + * Change the order of the table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + * @todo This really needs split up! + */ + function _fnSort ( oSettings ) + { + var + i, ien, iLen, j, jLen, k, kLen, + sDataType, nTh, + aiOrig = [], + oExtSort = DataTable.ext.type.order, + aoData = oSettings.aoData, + aoColumns = oSettings.aoColumns, + aDataSort, data, iCol, sType, oSort, + formatters = 0, + sortCol, + displayMaster = oSettings.aiDisplayMaster, + aSort; + + // Resolve any column types that are unknown due to addition or invalidation + // @todo Can this be moved into a 'data-ready' handler which is called when + // data is going to be used in the table? + _fnColumnTypes( oSettings ); + + aSort = _fnSortFlatten( oSettings ); + + for ( i=0, ien=aSort.length ; i<ien ; i++ ) { + sortCol = aSort[i]; + + // Track if we can use the fast sort algorithm + if ( sortCol.formatter ) { + formatters++; + } + + // Load the data needed for the sort, for each cell + _fnSortData( oSettings, sortCol.col ); + } + + /* No sorting required if server-side or no sorting array */ + if ( _fnDataSource( oSettings ) != 'ssp' && aSort.length !== 0 ) + { + // Create a value - key array of the current row positions such that we can use their + // current position during the sort, if values match, in order to perform stable sorting + for ( i=0, iLen=displayMaster.length ; i<iLen ; i++ ) { + aiOrig[ displayMaster[i] ] = i; + } + + /* Do the sort - here we want multi-column sorting based on a given data source (column) + * and sorting function (from oSort) in a certain direction. It's reasonably complex to + * follow on it's own, but this is what we want (example two column sorting): + * fnLocalSorting = function(a,b){ + * var iTest; + * iTest = oSort['string-asc']('data11', 'data12'); + * if (iTest !== 0) + * return iTest; + * iTest = oSort['numeric-desc']('data21', 'data22'); + * if (iTest !== 0) + * return iTest; + * return oSort['numeric-asc']( aiOrig[a], aiOrig[b] ); + * } + * Basically we have a test for each sorting column, if the data in that column is equal, + * test the next column. If all columns match, then we use a numeric sort on the row + * positions in the original data array to provide a stable sort. + * + * Note - I know it seems excessive to have two sorting methods, but the first is around + * 15% faster, so the second is only maintained for backwards compatibility with sorting + * methods which do not have a pre-sort formatting function. + */ + if ( formatters === aSort.length ) { + // All sort types have formatting functions + displayMaster.sort( function ( a, b ) { + var + x, y, k, test, sort, + len=aSort.length, + dataA = aoData[a]._aSortData, + dataB = aoData[b]._aSortData; + + for ( k=0 ; k<len ; k++ ) { + sort = aSort[k]; + + x = dataA[ sort.col ]; + y = dataB[ sort.col ]; + + test = x<y ? -1 : x>y ? 1 : 0; + if ( test !== 0 ) { + return sort.dir === 'asc' ? test : -test; + } + } + + x = aiOrig[a]; + y = aiOrig[b]; + return x<y ? -1 : x>y ? 1 : 0; + } ); + } + else { + // Depreciated - remove in 1.11 (providing a plug-in option) + // Not all sort types have formatting methods, so we have to call their sorting + // methods. + displayMaster.sort( function ( a, b ) { + var + x, y, k, l, test, sort, fn, + len=aSort.length, + dataA = aoData[a]._aSortData, + dataB = aoData[b]._aSortData; + + for ( k=0 ; k<len ; k++ ) { + sort = aSort[k]; + + x = dataA[ sort.col ]; + y = dataB[ sort.col ]; + + fn = oExtSort[ sort.type+"-"+sort.dir ] || oExtSort[ "string-"+sort.dir ]; + test = fn( x, y ); + if ( test !== 0 ) { + return test; + } + } + + x = aiOrig[a]; + y = aiOrig[b]; + return x<y ? -1 : x>y ? 1 : 0; + } ); + } + } + + /* Tell the draw function that we have sorted the data */ + oSettings.bSorted = true; + } + + + function _fnSortAria ( settings ) + { + var label; + var nextSort; + var columns = settings.aoColumns; + var aSort = _fnSortFlatten( settings ); + var oAria = settings.oLanguage.oAria; + + // ARIA attributes - need to loop all columns, to update all (removing old + // attributes as needed) + for ( var i=0, iLen=columns.length ; i<iLen ; i++ ) + { + var col = columns[i]; + var asSorting = col.asSorting; + var sTitle = col.ariaTitle || col.sTitle.replace( /<.*?>/g, "" ); + var th = col.nTh; + + // IE7 is throwing an error when setting these properties with jQuery's + // attr() and removeAttr() methods... + th.removeAttribute('aria-sort'); + + /* In ARIA only the first sorting column can be marked as sorting - no multi-sort option */ + if ( col.bSortable ) { + if ( aSort.length > 0 && aSort[0].col == i ) { + th.setAttribute('aria-sort', aSort[0].dir=="asc" ? "ascending" : "descending" ); + nextSort = asSorting[ aSort[0].index+1 ] || asSorting[0]; + } + else { + nextSort = asSorting[0]; + } + + label = sTitle + ( nextSort === "asc" ? + oAria.sSortAscending : + oAria.sSortDescending + ); + } + else { + label = sTitle; + } + + th.setAttribute('aria-label', label); + } + } + + + /** + * Function to run on user sort request + * @param {object} settings dataTables settings object + * @param {node} attachTo node to attach the handler to + * @param {int} colIdx column sorting index + * @param {boolean} [append=false] Append the requested sort to the existing + * sort if true (i.e. multi-column sort) + * @param {function} [callback] callback function + * @memberof DataTable#oApi + */ + function _fnSortListener ( settings, colIdx, append, callback ) + { + var col = settings.aoColumns[ colIdx ]; + var sorting = settings.aaSorting; + var asSorting = col.asSorting; + var nextSortIdx; + var next = function ( a, overflow ) { + var idx = a._idx; + if ( idx === undefined ) { + idx = $.inArray( a[1], asSorting ); + } + + return idx+1 < asSorting.length ? + idx+1 : + overflow ? + null : + 0; + }; + + // Convert to 2D array if needed + if ( typeof sorting[0] === 'number' ) { + sorting = settings.aaSorting = [ sorting ]; + } + + // If appending the sort then we are multi-column sorting + if ( append && settings.oFeatures.bSortMulti ) { + // Are we already doing some kind of sort on this column? + var sortIdx = $.inArray( colIdx, _pluck(sorting, '0') ); + + if ( sortIdx !== -1 ) { + // Yes, modify the sort + nextSortIdx = next( sorting[sortIdx], true ); + + if ( nextSortIdx === null && sorting.length === 1 ) { + nextSortIdx = 0; // can't remove sorting completely + } + + if ( nextSortIdx === null ) { + sorting.splice( sortIdx, 1 ); + } + else { + sorting[sortIdx][1] = asSorting[ nextSortIdx ]; + sorting[sortIdx]._idx = nextSortIdx; + } + } + else { + // No sort on this column yet + sorting.push( [ colIdx, asSorting[0], 0 ] ); + sorting[sorting.length-1]._idx = 0; + } + } + else if ( sorting.length && sorting[0][0] == colIdx ) { + // Single column - already sorting on this column, modify the sort + nextSortIdx = next( sorting[0] ); + + sorting.length = 1; + sorting[0][1] = asSorting[ nextSortIdx ]; + sorting[0]._idx = nextSortIdx; + } + else { + // Single column - sort only on this column + sorting.length = 0; + sorting.push( [ colIdx, asSorting[0] ] ); + sorting[0]._idx = 0; + } + + // Run the sort by calling a full redraw + _fnReDraw( settings ); + + // callback used for async user interaction + if ( typeof callback == 'function' ) { + callback( settings ); + } + } + + + /** + * Attach a sort handler (click) to a node + * @param {object} settings dataTables settings object + * @param {node} attachTo node to attach the handler to + * @param {int} colIdx column sorting index + * @param {function} [callback] callback function + * @memberof DataTable#oApi + */ + function _fnSortAttachListener ( settings, attachTo, colIdx, callback ) + { + var col = settings.aoColumns[ colIdx ]; + + _fnBindAction( attachTo, {}, function (e) { + /* If the column is not sortable - don't to anything */ + if ( col.bSortable === false ) { + return; + } + + // If processing is enabled use a timeout to allow the processing + // display to be shown - otherwise to it synchronously + if ( settings.oFeatures.bProcessing ) { + _fnProcessingDisplay( settings, true ); + + setTimeout( function() { + _fnSortListener( settings, colIdx, e.shiftKey, callback ); + + // In server-side processing, the draw callback will remove the + // processing display + if ( _fnDataSource( settings ) !== 'ssp' ) { + _fnProcessingDisplay( settings, false ); + } + }, 0 ); + } + else { + _fnSortListener( settings, colIdx, e.shiftKey, callback ); + } + } ); + } + + + /** + * Set the sorting classes on table's body, Note: it is safe to call this function + * when bSort and bSortClasses are false + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnSortingClasses( settings ) + { + var oldSort = settings.aLastSort; + var sortClass = settings.oClasses.sSortColumn; + var sort = _fnSortFlatten( settings ); + var features = settings.oFeatures; + var i, ien, colIdx; + + if ( features.bSort && features.bSortClasses ) { + // Remove old sorting classes + for ( i=0, ien=oldSort.length ; i<ien ; i++ ) { + colIdx = oldSort[i].src; + + // Remove column sorting + $( _pluck( settings.aoData, 'anCells', colIdx ) ) + .removeClass( sortClass + (i<2 ? i+1 : 3) ); + } + + // Add new column sorting + for ( i=0, ien=sort.length ; i<ien ; i++ ) { + colIdx = sort[i].src; + + $( _pluck( settings.aoData, 'anCells', colIdx ) ) + .addClass( sortClass + (i<2 ? i+1 : 3) ); + } + } + + settings.aLastSort = sort; + } + + + // Get the data to sort a column, be it from cache, fresh (populating the + // cache), or from a sort formatter + function _fnSortData( settings, idx ) + { + // Custom sorting function - provided by the sort data type + var column = settings.aoColumns[ idx ]; + var customSort = DataTable.ext.order[ column.sSortDataType ]; + var customData; + + if ( customSort ) { + customData = customSort.call( settings.oInstance, settings, idx, + _fnColumnIndexToVisible( settings, idx ) + ); + } + + // Use / populate cache + var row, cellData; + var formatter = DataTable.ext.type.order[ column.sType+"-pre" ]; + + for ( var i=0, ien=settings.aoData.length ; i<ien ; i++ ) { + row = settings.aoData[i]; + + if ( ! row._aSortData ) { + row._aSortData = []; + } + + if ( ! row._aSortData[idx] || customSort ) { + cellData = customSort ? + customData[i] : // If there was a custom sort function, use data from there + _fnGetCellData( settings, i, idx, 'sort' ); + + row._aSortData[ idx ] = formatter ? + formatter( cellData ) : + cellData; + } + } + } + + + + /** + * Save the state of a table + * @param {object} oSettings dataTables settings object + * @memberof DataTable#oApi + */ + function _fnSaveState ( settings ) + { + if (settings._bLoadingState) { + return; + } + + /* Store the interesting variables */ + var state = { + time: +new Date(), + start: settings._iDisplayStart, + length: settings._iDisplayLength, + order: $.extend( true, [], settings.aaSorting ), + search: _fnSearchToCamel( settings.oPreviousSearch ), + columns: $.map( settings.aoColumns, function ( col, i ) { + return { + visible: col.bVisible, + search: _fnSearchToCamel( settings.aoPreSearchCols[i] ) + }; + } ) + }; + + settings.oSavedState = state; + _fnCallbackFire( settings, "aoStateSaveParams", 'stateSaveParams', [settings, state] ); + + if ( settings.oFeatures.bStateSave && !settings.bDestroying ) + { + settings.fnStateSaveCallback.call( settings.oInstance, settings, state ); + } + } + + + /** + * Attempt to load a saved table state + * @param {object} oSettings dataTables settings object + * @param {object} oInit DataTables init object so we can override settings + * @param {function} callback Callback to execute when the state has been loaded + * @memberof DataTable#oApi + */ + function _fnLoadState ( settings, oInit, callback ) + { + if ( ! settings.oFeatures.bStateSave ) { + callback(); + return; + } + + var loaded = function(state) { + _fnImplementState(settings, state, callback); + } + + var state = settings.fnStateLoadCallback.call( settings.oInstance, settings, loaded ); + + if ( state !== undefined ) { + _fnImplementState( settings, state, callback ); + } + // otherwise, wait for the loaded callback to be executed + + return true; + } + + function _fnImplementState ( settings, s, callback) { + var i, ien; + var columns = settings.aoColumns; + settings._bLoadingState = true; + + // When StateRestore was introduced the state could now be implemented at any time + // Not just initialisation. To do this an api instance is required in some places + var api = settings._bInitComplete ? new DataTable.Api(settings) : null; + + if ( ! s || ! s.time ) { + settings._bLoadingState = false; + callback(); + return; + } + + // Allow custom and plug-in manipulation functions to alter the saved data set and + // cancelling of loading by returning false + var abStateLoad = _fnCallbackFire( settings, 'aoStateLoadParams', 'stateLoadParams', [settings, s] ); + if ( $.inArray( false, abStateLoad ) !== -1 ) { + settings._bLoadingState = false; + callback(); + return; + } + + // Reject old data + var duration = settings.iStateDuration; + if ( duration > 0 && s.time < +new Date() - (duration*1000) ) { + settings._bLoadingState = false; + callback(); + return; + } + + // Number of columns have changed - all bets are off, no restore of settings + if ( s.columns && columns.length !== s.columns.length ) { + settings._bLoadingState = false; + callback(); + return; + } + + // Store the saved state so it might be accessed at any time + settings.oLoadedState = $.extend( true, {}, s ); + + // Restore key features - todo - for 1.11 this needs to be done by + // subscribed events + if ( s.start !== undefined ) { + if(api === null) { + settings._iDisplayStart = s.start; + settings.iInitDisplayStart = s.start; + } + else { + _fnPageChange(settings, s.start/s.length); + + } + } + if ( s.length !== undefined ) { + settings._iDisplayLength = s.length; + } + + // Order + if ( s.order !== undefined ) { + settings.aaSorting = []; + $.each( s.order, function ( i, col ) { + settings.aaSorting.push( col[0] >= columns.length ? + [ 0, col[1] ] : + col + ); + } ); + } + + // Search + if ( s.search !== undefined ) { + $.extend( settings.oPreviousSearch, _fnSearchToHung( s.search ) ); + } + + // Columns + if ( s.columns ) { + for ( i=0, ien=s.columns.length ; i<ien ; i++ ) { + var col = s.columns[i]; + + // Visibility + if ( col.visible !== undefined ) { + // If the api is defined, the table has been initialised so we need to use it rather than internal settings + if (api) { + // Don't redraw the columns on every iteration of this loop, we will do this at the end instead + api.column(i).visible(col.visible, false); + } + else { + columns[i].bVisible = col.visible; + } + } + + // Search + if ( col.search !== undefined ) { + $.extend( settings.aoPreSearchCols[i], _fnSearchToHung( col.search ) ); + } + } + + // If the api is defined then we need to adjust the columns once the visibility has been changed + if (api) { + api.columns.adjust(); + } + } + + settings._bLoadingState = false; + _fnCallbackFire( settings, 'aoStateLoaded', 'stateLoaded', [settings, s] ); + callback(); + }; + + + /** + * Return the settings object for a particular table + * @param {node} table table we are using as a dataTable + * @returns {object} Settings object - or null if not found + * @memberof DataTable#oApi + */ + function _fnSettingsFromNode ( table ) + { + var settings = DataTable.settings; + var idx = $.inArray( table, _pluck( settings, 'nTable' ) ); + + return idx !== -1 ? + settings[ idx ] : + null; + } + + + /** + * Log an error message + * @param {object} settings dataTables settings object + * @param {int} level log error messages, or display them to the user + * @param {string} msg error message + * @param {int} tn Technical note id to get more information about the error. + * @memberof DataTable#oApi + */ + function _fnLog( settings, level, msg, tn ) + { + msg = 'DataTables warning: '+ + (settings ? 'table id='+settings.sTableId+' - ' : '')+msg; + + if ( tn ) { + msg += '. For more information about this error, please see '+ + 'http://datatables.net/tn/'+tn; + } + + if ( ! level ) { + // Backwards compatibility pre 1.10 + var ext = DataTable.ext; + var type = ext.sErrMode || ext.errMode; + + if ( settings ) { + _fnCallbackFire( settings, null, 'error', [ settings, tn, msg ] ); + } + + if ( type == 'alert' ) { + alert( msg ); + } + else if ( type == 'throw' ) { + throw new Error(msg); + } + else if ( typeof type == 'function' ) { + type( settings, tn, msg ); + } + } + else if ( window.console && console.log ) { + console.log( msg ); + } + } + + + /** + * See if a property is defined on one object, if so assign it to the other object + * @param {object} ret target object + * @param {object} src source object + * @param {string} name property + * @param {string} [mappedName] name to map too - optional, name used if not given + * @memberof DataTable#oApi + */ + function _fnMap( ret, src, name, mappedName ) + { + if ( Array.isArray( name ) ) { + $.each( name, function (i, val) { + if ( Array.isArray( val ) ) { + _fnMap( ret, src, val[0], val[1] ); + } + else { + _fnMap( ret, src, val ); + } + } ); + + return; + } + + if ( mappedName === undefined ) { + mappedName = name; + } + + if ( src[name] !== undefined ) { + ret[mappedName] = src[name]; + } + } + + + /** + * Extend objects - very similar to jQuery.extend, but deep copy objects, and + * shallow copy arrays. The reason we need to do this, is that we don't want to + * deep copy array init values (such as aaSorting) since the dev wouldn't be + * able to override them, but we do want to deep copy arrays. + * @param {object} out Object to extend + * @param {object} extender Object from which the properties will be applied to + * out + * @param {boolean} breakRefs If true, then arrays will be sliced to take an + * independent copy with the exception of the `data` or `aaData` parameters + * if they are present. This is so you can pass in a collection to + * DataTables and have that used as your data source without breaking the + * references + * @returns {object} out Reference, just for convenience - out === the return. + * @memberof DataTable#oApi + * @todo This doesn't take account of arrays inside the deep copied objects. + */ + function _fnExtend( out, extender, breakRefs ) + { + var val; + + for ( var prop in extender ) { + if ( extender.hasOwnProperty(prop) ) { + val = extender[prop]; + + if ( $.isPlainObject( val ) ) { + if ( ! $.isPlainObject( out[prop] ) ) { + out[prop] = {}; + } + $.extend( true, out[prop], val ); + } + else if ( breakRefs && prop !== 'data' && prop !== 'aaData' && Array.isArray(val) ) { + out[prop] = val.slice(); + } + else { + out[prop] = val; + } + } + } + + return out; + } + + + /** + * Bind an event handers to allow a click or return key to activate the callback. + * This is good for accessibility since a return on the keyboard will have the + * same effect as a click, if the element has focus. + * @param {element} n Element to bind the action to + * @param {object} oData Data object to pass to the triggered function + * @param {function} fn Callback function for when the event is triggered + * @memberof DataTable#oApi + */ + function _fnBindAction( n, oData, fn ) + { + $(n) + .on( 'click.DT', oData, function (e) { + $(n).trigger('blur'); // Remove focus outline for mouse users + fn(e); + } ) + .on( 'keypress.DT', oData, function (e){ + if ( e.which === 13 ) { + e.preventDefault(); + fn(e); + } + } ) + .on( 'selectstart.DT', function () { + /* Take the brutal approach to cancelling text selection */ + return false; + } ); + } + + + /** + * Register a callback function. Easily allows a callback function to be added to + * an array store of callback functions that can then all be called together. + * @param {object} oSettings dataTables settings object + * @param {string} sStore Name of the array storage for the callbacks in oSettings + * @param {function} fn Function to be called back + * @param {string} sName Identifying name for the callback (i.e. a label) + * @memberof DataTable#oApi + */ + function _fnCallbackReg( oSettings, sStore, fn, sName ) + { + if ( fn ) + { + oSettings[sStore].push( { + "fn": fn, + "sName": sName + } ); + } + } + + + /** + * Fire callback functions and trigger events. Note that the loop over the + * callback array store is done backwards! Further note that you do not want to + * fire off triggers in time sensitive applications (for example cell creation) + * as its slow. + * @param {object} settings dataTables settings object + * @param {string} callbackArr Name of the array storage for the callbacks in + * oSettings + * @param {string} eventName Name of the jQuery custom event to trigger. If + * null no trigger is fired + * @param {array} args Array of arguments to pass to the callback function / + * trigger + * @memberof DataTable#oApi + */ + function _fnCallbackFire( settings, callbackArr, eventName, args ) + { + var ret = []; + + if ( callbackArr ) { + ret = $.map( settings[callbackArr].slice().reverse(), function (val, i) { + return val.fn.apply( settings.oInstance, args ); + } ); + } + + if ( eventName !== null ) { + var e = $.Event( eventName+'.dt' ); + + $(settings.nTable).trigger( e, args ); + + ret.push( e.result ); + } + + return ret; + } + + + function _fnLengthOverflow ( settings ) + { + var + start = settings._iDisplayStart, + end = settings.fnDisplayEnd(), + len = settings._iDisplayLength; + + /* If we have space to show extra rows (backing up from the end point - then do so */ + if ( start >= end ) + { + start = end - len; + } + + // Keep the start record on the current page + start -= (start % len); + + if ( len === -1 || start < 0 ) + { + start = 0; + } + + settings._iDisplayStart = start; + } + + + function _fnRenderer( settings, type ) + { + var renderer = settings.renderer; + var host = DataTable.ext.renderer[type]; + + if ( $.isPlainObject( renderer ) && renderer[type] ) { + // Specific renderer for this type. If available use it, otherwise use + // the default. + return host[renderer[type]] || host._; + } + else if ( typeof renderer === 'string' ) { + // Common renderer - if there is one available for this type use it, + // otherwise use the default + return host[renderer] || host._; + } + + // Use the default + return host._; + } + + + /** + * Detect the data source being used for the table. Used to simplify the code + * a little (ajax) and to make it compress a little smaller. + * + * @param {object} settings dataTables settings object + * @returns {string} Data source + * @memberof DataTable#oApi + */ + function _fnDataSource ( settings ) + { + if ( settings.oFeatures.bServerSide ) { + return 'ssp'; + } + else if ( settings.ajax || settings.sAjaxSource ) { + return 'ajax'; + } + return 'dom'; + } + + + + + /** + * Computed structure of the DataTables API, defined by the options passed to + * `DataTable.Api.register()` when building the API. + * + * The structure is built in order to speed creation and extension of the Api + * objects since the extensions are effectively pre-parsed. + * + * The array is an array of objects with the following structure, where this + * base array represents the Api prototype base: + * + * [ + * { + * name: 'data' -- string - Property name + * val: function () {}, -- function - Api method (or undefined if just an object + * methodExt: [ ... ], -- array - Array of Api object definitions to extend the method result + * propExt: [ ... ] -- array - Array of Api object definitions to extend the property + * }, + * { + * name: 'row' + * val: {}, + * methodExt: [ ... ], + * propExt: [ + * { + * name: 'data' + * val: function () {}, + * methodExt: [ ... ], + * propExt: [ ... ] + * }, + * ... + * ] + * } + * ] + * + * @type {Array} + * @ignore + */ + var __apiStruct = []; + + + /** + * `Array.prototype` reference. + * + * @type object + * @ignore + */ + var __arrayProto = Array.prototype; + + + /** + * Abstraction for `context` parameter of the `Api` constructor to allow it to + * take several different forms for ease of use. + * + * Each of the input parameter types will be converted to a DataTables settings + * object where possible. + * + * @param {string|node|jQuery|object} mixed DataTable identifier. Can be one + * of: + * + * * `string` - jQuery selector. Any DataTables' matching the given selector + * with be found and used. + * * `node` - `TABLE` node which has already been formed into a DataTable. + * * `jQuery` - A jQuery object of `TABLE` nodes. + * * `object` - DataTables settings object + * * `DataTables.Api` - API instance + * @return {array|null} Matching DataTables settings objects. `null` or + * `undefined` is returned if no matching DataTable is found. + * @ignore + */ + var _toSettings = function ( mixed ) + { + var idx, jq; + var settings = DataTable.settings; + var tables = $.map( settings, function (el, i) { + return el.nTable; + } ); + + if ( ! mixed ) { + return []; + } + else if ( mixed.nTable && mixed.oApi ) { + // DataTables settings object + return [ mixed ]; + } + else if ( mixed.nodeName && mixed.nodeName.toLowerCase() === 'table' ) { + // Table node + idx = $.inArray( mixed, tables ); + return idx !== -1 ? [ settings[idx] ] : null; + } + else if ( mixed && typeof mixed.settings === 'function' ) { + return mixed.settings().toArray(); + } + else if ( typeof mixed === 'string' ) { + // jQuery selector + jq = $(mixed); + } + else if ( mixed instanceof $ ) { + // jQuery object (also DataTables instance) + jq = mixed; + } + + if ( jq ) { + return jq.map( function(i) { + idx = $.inArray( this, tables ); + return idx !== -1 ? settings[idx] : null; + } ).toArray(); + } + }; + + + /** + * DataTables API class - used to control and interface with one or more + * DataTables enhanced tables. + * + * The API class is heavily based on jQuery, presenting a chainable interface + * that you can use to interact with tables. Each instance of the API class has + * a "context" - i.e. the tables that it will operate on. This could be a single + * table, all tables on a page or a sub-set thereof. + * + * Additionally the API is designed to allow you to easily work with the data in + * the tables, retrieving and manipulating it as required. This is done by + * presenting the API class as an array like interface. The contents of the + * array depend upon the actions requested by each method (for example + * `rows().nodes()` will return an array of nodes, while `rows().data()` will + * return an array of objects or arrays depending upon your table's + * configuration). The API object has a number of array like methods (`push`, + * `pop`, `reverse` etc) as well as additional helper methods (`each`, `pluck`, + * `unique` etc) to assist your working with the data held in a table. + * + * Most methods (those which return an Api instance) are chainable, which means + * the return from a method call also has all of the methods available that the + * top level object had. For example, these two calls are equivalent: + * + * // Not chained + * api.row.add( {...} ); + * api.draw(); + * + * // Chained + * api.row.add( {...} ).draw(); + * + * @class DataTable.Api + * @param {array|object|string|jQuery} context DataTable identifier. This is + * used to define which DataTables enhanced tables this API will operate on. + * Can be one of: + * + * * `string` - jQuery selector. Any DataTables' matching the given selector + * with be found and used. + * * `node` - `TABLE` node which has already been formed into a DataTable. + * * `jQuery` - A jQuery object of `TABLE` nodes. + * * `object` - DataTables settings object + * @param {array} [data] Data to initialise the Api instance with. + * + * @example + * // Direct initialisation during DataTables construction + * var api = $('#example').DataTable(); + * + * @example + * // Initialisation using a DataTables jQuery object + * var api = $('#example').dataTable().api(); + * + * @example + * // Initialisation as a constructor + * var api = new $.fn.DataTable.Api( 'table.dataTable' ); + */ + _Api = function ( context, data ) + { + if ( ! (this instanceof _Api) ) { + return new _Api( context, data ); + } + + var settings = []; + var ctxSettings = function ( o ) { + var a = _toSettings( o ); + if ( a ) { + settings.push.apply( settings, a ); + } + }; + + if ( Array.isArray( context ) ) { + for ( var i=0, ien=context.length ; i<ien ; i++ ) { + ctxSettings( context[i] ); + } + } + else { + ctxSettings( context ); + } + + // Remove duplicates + this.context = _unique( settings ); + + // Initial data + if ( data ) { + $.merge( this, data ); + } + + // selector + this.selector = { + rows: null, + cols: null, + opts: null + }; + + _Api.extend( this, this, __apiStruct ); + }; + + DataTable.Api = _Api; + + // Don't destroy the existing prototype, just extend it. Required for jQuery 2's + // isPlainObject. + $.extend( _Api.prototype, { + any: function () + { + return this.count() !== 0; + }, + + + concat: __arrayProto.concat, + + + context: [], // array of table settings objects + + + count: function () + { + return this.flatten().length; + }, + + + each: function ( fn ) + { + for ( var i=0, ien=this.length ; i<ien; i++ ) { + fn.call( this, this[i], i, this ); + } + + return this; + }, + + + eq: function ( idx ) + { + var ctx = this.context; + + return ctx.length > idx ? + new _Api( ctx[idx], this[idx] ) : + null; + }, + + + filter: function ( fn ) + { + var a = []; + + if ( __arrayProto.filter ) { + a = __arrayProto.filter.call( this, fn, this ); + } + else { + // Compatibility for browsers without EMCA-252-5 (JS 1.6) + for ( var i=0, ien=this.length ; i<ien ; i++ ) { + if ( fn.call( this, this[i], i, this ) ) { + a.push( this[i] ); + } + } + } + + return new _Api( this.context, a ); + }, + + + flatten: function () + { + var a = []; + return new _Api( this.context, a.concat.apply( a, this.toArray() ) ); + }, + + + join: __arrayProto.join, + + + indexOf: __arrayProto.indexOf || function (obj, start) + { + for ( var i=(start || 0), ien=this.length ; i<ien ; i++ ) { + if ( this[i] === obj ) { + return i; + } + } + return -1; + }, + + iterator: function ( flatten, type, fn, alwaysNew ) { + var + a = [], ret, + i, ien, j, jen, + context = this.context, + rows, items, item, + selector = this.selector; + + // Argument shifting + if ( typeof flatten === 'string' ) { + alwaysNew = fn; + fn = type; + type = flatten; + flatten = false; + } + + for ( i=0, ien=context.length ; i<ien ; i++ ) { + var apiInst = new _Api( context[i] ); + + if ( type === 'table' ) { + ret = fn.call( apiInst, context[i], i ); + + if ( ret !== undefined ) { + a.push( ret ); + } + } + else if ( type === 'columns' || type === 'rows' ) { + // this has same length as context - one entry for each table + ret = fn.call( apiInst, context[i], this[i], i ); + + if ( ret !== undefined ) { + a.push( ret ); + } + } + else if ( type === 'column' || type === 'column-rows' || type === 'row' || type === 'cell' ) { + // columns and rows share the same structure. + // 'this' is an array of column indexes for each context + items = this[i]; + + if ( type === 'column-rows' ) { + rows = _selector_row_indexes( context[i], selector.opts ); + } + + for ( j=0, jen=items.length ; j<jen ; j++ ) { + item = items[j]; + + if ( type === 'cell' ) { + ret = fn.call( apiInst, context[i], item.row, item.column, i, j ); + } + else { + ret = fn.call( apiInst, context[i], item, i, j, rows ); + } + + if ( ret !== undefined ) { + a.push( ret ); + } + } + } + } + + if ( a.length || alwaysNew ) { + var api = new _Api( context, flatten ? a.concat.apply( [], a ) : a ); + var apiSelector = api.selector; + apiSelector.rows = selector.rows; + apiSelector.cols = selector.cols; + apiSelector.opts = selector.opts; + return api; + } + return this; + }, + + + lastIndexOf: __arrayProto.lastIndexOf || function (obj, start) + { + // Bit cheeky... + return this.indexOf.apply( this.toArray.reverse(), arguments ); + }, + + + length: 0, + + + map: function ( fn ) + { + var a = []; + + if ( __arrayProto.map ) { + a = __arrayProto.map.call( this, fn, this ); + } + else { + // Compatibility for browsers without EMCA-252-5 (JS 1.6) + for ( var i=0, ien=this.length ; i<ien ; i++ ) { + a.push( fn.call( this, this[i], i ) ); + } + } + + return new _Api( this.context, a ); + }, + + + pluck: function ( prop ) + { + return this.map( function ( el ) { + return el[ prop ]; + } ); + }, + + pop: __arrayProto.pop, + + + push: __arrayProto.push, + + + // Does not return an API instance + reduce: __arrayProto.reduce || function ( fn, init ) + { + return _fnReduce( this, fn, init, 0, this.length, 1 ); + }, + + + reduceRight: __arrayProto.reduceRight || function ( fn, init ) + { + return _fnReduce( this, fn, init, this.length-1, -1, -1 ); + }, + + + reverse: __arrayProto.reverse, + + + // Object with rows, columns and opts + selector: null, + + + shift: __arrayProto.shift, + + + slice: function () { + return new _Api( this.context, this ); + }, + + + sort: __arrayProto.sort, // ? name - order? + + + splice: __arrayProto.splice, + + + toArray: function () + { + return __arrayProto.slice.call( this ); + }, + + + to$: function () + { + return $( this ); + }, + + + toJQuery: function () + { + return $( this ); + }, + + + unique: function () + { + return new _Api( this.context, _unique(this) ); + }, + + + unshift: __arrayProto.unshift + } ); + + + _Api.extend = function ( scope, obj, ext ) + { + // Only extend API instances and static properties of the API + if ( ! ext.length || ! obj || ( ! (obj instanceof _Api) && ! obj.__dt_wrapper ) ) { + return; + } + + var + i, ien, + struct, + methodScoping = function ( scope, fn, struc ) { + return function () { + var ret = fn.apply( scope, arguments ); + + // Method extension + _Api.extend( ret, ret, struc.methodExt ); + return ret; + }; + }; + + for ( i=0, ien=ext.length ; i<ien ; i++ ) { + struct = ext[i]; + + // Value + obj[ struct.name ] = struct.type === 'function' ? + methodScoping( scope, struct.val, struct ) : + struct.type === 'object' ? + {} : + struct.val; + + obj[ struct.name ].__dt_wrapper = true; + + // Property extension + _Api.extend( scope, obj[ struct.name ], struct.propExt ); + } + }; + + + // @todo - Is there need for an augment function? + // _Api.augment = function ( inst, name ) + // { + // // Find src object in the structure from the name + // var parts = name.split('.'); + + // _Api.extend( inst, obj ); + // }; + + + // [ + // { + // name: 'data' -- string - Property name + // val: function () {}, -- function - Api method (or undefined if just an object + // methodExt: [ ... ], -- array - Array of Api object definitions to extend the method result + // propExt: [ ... ] -- array - Array of Api object definitions to extend the property + // }, + // { + // name: 'row' + // val: {}, + // methodExt: [ ... ], + // propExt: [ + // { + // name: 'data' + // val: function () {}, + // methodExt: [ ... ], + // propExt: [ ... ] + // }, + // ... + // ] + // } + // ] + + _Api.register = _api_register = function ( name, val ) + { + if ( Array.isArray( name ) ) { + for ( var j=0, jen=name.length ; j<jen ; j++ ) { + _Api.register( name[j], val ); + } + return; + } + + var + i, ien, + heir = name.split('.'), + struct = __apiStruct, + key, method; + + var find = function ( src, name ) { + for ( var i=0, ien=src.length ; i<ien ; i++ ) { + if ( src[i].name === name ) { + return src[i]; + } + } + return null; + }; + + for ( i=0, ien=heir.length ; i<ien ; i++ ) { + method = heir[i].indexOf('()') !== -1; + key = method ? + heir[i].replace('()', '') : + heir[i]; + + var src = find( struct, key ); + if ( ! src ) { + src = { + name: key, + val: {}, + methodExt: [], + propExt: [], + type: 'object' + }; + struct.push( src ); + } + + if ( i === ien-1 ) { + src.val = val; + src.type = typeof val === 'function' ? + 'function' : + $.isPlainObject( val ) ? + 'object' : + 'other'; + } + else { + struct = method ? + src.methodExt : + src.propExt; + } + } + }; + + _Api.registerPlural = _api_registerPlural = function ( pluralName, singularName, val ) { + _Api.register( pluralName, val ); + + _Api.register( singularName, function () { + var ret = val.apply( this, arguments ); + + if ( ret === this ) { + // Returned item is the API instance that was passed in, return it + return this; + } + else if ( ret instanceof _Api ) { + // New API instance returned, want the value from the first item + // in the returned array for the singular result. + return ret.length ? + Array.isArray( ret[0] ) ? + new _Api( ret.context, ret[0] ) : // Array results are 'enhanced' + ret[0] : + undefined; + } + + // Non-API return - just fire it back + return ret; + } ); + }; + + + /** + * Selector for HTML tables. Apply the given selector to the give array of + * DataTables settings objects. + * + * @param {string|integer} [selector] jQuery selector string or integer + * @param {array} Array of DataTables settings objects to be filtered + * @return {array} + * @ignore + */ + var __table_selector = function ( selector, a ) + { + if ( Array.isArray(selector) ) { + return $.map( selector, function (item) { + return __table_selector(item, a); + } ); + } + + // Integer is used to pick out a table by index + if ( typeof selector === 'number' ) { + return [ a[ selector ] ]; + } + + // Perform a jQuery selector on the table nodes + var nodes = $.map( a, function (el, i) { + return el.nTable; + } ); + + return $(nodes) + .filter( selector ) + .map( function (i) { + // Need to translate back from the table node to the settings + var idx = $.inArray( this, nodes ); + return a[ idx ]; + } ) + .toArray(); + }; + + + + /** + * Context selector for the API's context (i.e. the tables the API instance + * refers to. + * + * @name DataTable.Api#tables + * @param {string|integer} [selector] Selector to pick which tables the iterator + * should operate on. If not given, all tables in the current context are + * used. This can be given as a jQuery selector (for example `':gt(0)'`) to + * select multiple tables or as an integer to select a single table. + * @returns {DataTable.Api} Returns a new API instance if a selector is given. + */ + _api_register( 'tables()', function ( selector ) { + // A new instance is created if there was a selector specified + return selector !== undefined && selector !== null ? + new _Api( __table_selector( selector, this.context ) ) : + this; + } ); + + + _api_register( 'table()', function ( selector ) { + var tables = this.tables( selector ); + var ctx = tables.context; + + // Truncate to the first matched table + return ctx.length ? + new _Api( ctx[0] ) : + tables; + } ); + + + _api_registerPlural( 'tables().nodes()', 'table().node()' , function () { + return this.iterator( 'table', function ( ctx ) { + return ctx.nTable; + }, 1 ); + } ); + + + _api_registerPlural( 'tables().body()', 'table().body()' , function () { + return this.iterator( 'table', function ( ctx ) { + return ctx.nTBody; + }, 1 ); + } ); + + + _api_registerPlural( 'tables().header()', 'table().header()' , function () { + return this.iterator( 'table', function ( ctx ) { + return ctx.nTHead; + }, 1 ); + } ); + + + _api_registerPlural( 'tables().footer()', 'table().footer()' , function () { + return this.iterator( 'table', function ( ctx ) { + return ctx.nTFoot; + }, 1 ); + } ); + + + _api_registerPlural( 'tables().containers()', 'table().container()' , function () { + return this.iterator( 'table', function ( ctx ) { + return ctx.nTableWrapper; + }, 1 ); + } ); + + + + /** + * Redraw the tables in the current context. + */ + _api_register( 'draw()', function ( paging ) { + return this.iterator( 'table', function ( settings ) { + if ( paging === 'page' ) { + _fnDraw( settings ); + } + else { + if ( typeof paging === 'string' ) { + paging = paging === 'full-hold' ? + false : + true; + } + + _fnReDraw( settings, paging===false ); + } + } ); + } ); + + + + /** + * Get the current page index. + * + * @return {integer} Current page index (zero based) + *//** + * Set the current page. + * + * Note that if you attempt to show a page which does not exist, DataTables will + * not throw an error, but rather reset the paging. + * + * @param {integer|string} action The paging action to take. This can be one of: + * * `integer` - The page index to jump to + * * `string` - An action to take: + * * `first` - Jump to first page. + * * `next` - Jump to the next page + * * `previous` - Jump to previous page + * * `last` - Jump to the last page. + * @returns {DataTables.Api} this + */ + _api_register( 'page()', function ( action ) { + if ( action === undefined ) { + return this.page.info().page; // not an expensive call + } + + // else, have an action to take on all tables + return this.iterator( 'table', function ( settings ) { + _fnPageChange( settings, action ); + } ); + } ); + + + /** + * Paging information for the first table in the current context. + * + * If you require paging information for another table, use the `table()` method + * with a suitable selector. + * + * @return {object} Object with the following properties set: + * * `page` - Current page index (zero based - i.e. the first page is `0`) + * * `pages` - Total number of pages + * * `start` - Display index for the first record shown on the current page + * * `end` - Display index for the last record shown on the current page + * * `length` - Display length (number of records). Note that generally `start + * + length = end`, but this is not always true, for example if there are + * only 2 records to show on the final page, with a length of 10. + * * `recordsTotal` - Full data set length + * * `recordsDisplay` - Data set length once the current filtering criterion + * are applied. + */ + _api_register( 'page.info()', function ( action ) { + if ( this.context.length === 0 ) { + return undefined; + } + + var + settings = this.context[0], + start = settings._iDisplayStart, + len = settings.oFeatures.bPaginate ? settings._iDisplayLength : -1, + visRecords = settings.fnRecordsDisplay(), + all = len === -1; + + return { + "page": all ? 0 : Math.floor( start / len ), + "pages": all ? 1 : Math.ceil( visRecords / len ), + "start": start, + "end": settings.fnDisplayEnd(), + "length": len, + "recordsTotal": settings.fnRecordsTotal(), + "recordsDisplay": visRecords, + "serverSide": _fnDataSource( settings ) === 'ssp' + }; + } ); + + + /** + * Get the current page length. + * + * @return {integer} Current page length. Note `-1` indicates that all records + * are to be shown. + *//** + * Set the current page length. + * + * @param {integer} Page length to set. Use `-1` to show all records. + * @returns {DataTables.Api} this + */ + _api_register( 'page.len()', function ( len ) { + // Note that we can't call this function 'length()' because `length` + // is a Javascript property of functions which defines how many arguments + // the function expects. + if ( len === undefined ) { + return this.context.length !== 0 ? + this.context[0]._iDisplayLength : + undefined; + } + + // else, set the page length + return this.iterator( 'table', function ( settings ) { + _fnLengthChange( settings, len ); + } ); + } ); + + + + var __reload = function ( settings, holdPosition, callback ) { + // Use the draw event to trigger a callback + if ( callback ) { + var api = new _Api( settings ); + + api.one( 'draw', function () { + callback( api.ajax.json() ); + } ); + } + + if ( _fnDataSource( settings ) == 'ssp' ) { + _fnReDraw( settings, holdPosition ); + } + else { + _fnProcessingDisplay( settings, true ); + + // Cancel an existing request + var xhr = settings.jqXHR; + if ( xhr && xhr.readyState !== 4 ) { + xhr.abort(); + } + + // Trigger xhr + _fnBuildAjax( settings, [], function( json ) { + _fnClearTable( settings ); + + var data = _fnAjaxDataSrc( settings, json ); + for ( var i=0, ien=data.length ; i<ien ; i++ ) { + _fnAddData( settings, data[i] ); + } + + _fnReDraw( settings, holdPosition ); + _fnProcessingDisplay( settings, false ); + } ); + } + }; + + + /** + * Get the JSON response from the last Ajax request that DataTables made to the + * server. Note that this returns the JSON from the first table in the current + * context. + * + * @return {object} JSON received from the server. + */ + _api_register( 'ajax.json()', function () { + var ctx = this.context; + + if ( ctx.length > 0 ) { + return ctx[0].json; + } + + // else return undefined; + } ); + + + /** + * Get the data submitted in the last Ajax request + */ + _api_register( 'ajax.params()', function () { + var ctx = this.context; + + if ( ctx.length > 0 ) { + return ctx[0].oAjaxData; + } + + // else return undefined; + } ); + + + /** + * Reload tables from the Ajax data source. Note that this function will + * automatically re-draw the table when the remote data has been loaded. + * + * @param {boolean} [reset=true] Reset (default) or hold the current paging + * position. A full re-sort and re-filter is performed when this method is + * called, which is why the pagination reset is the default action. + * @returns {DataTables.Api} this + */ + _api_register( 'ajax.reload()', function ( callback, resetPaging ) { + return this.iterator( 'table', function (settings) { + __reload( settings, resetPaging===false, callback ); + } ); + } ); + + + /** + * Get the current Ajax URL. Note that this returns the URL from the first + * table in the current context. + * + * @return {string} Current Ajax source URL + *//** + * Set the Ajax URL. Note that this will set the URL for all tables in the + * current context. + * + * @param {string} url URL to set. + * @returns {DataTables.Api} this + */ + _api_register( 'ajax.url()', function ( url ) { + var ctx = this.context; + + if ( url === undefined ) { + // get + if ( ctx.length === 0 ) { + return undefined; + } + ctx = ctx[0]; + + return ctx.ajax ? + $.isPlainObject( ctx.ajax ) ? + ctx.ajax.url : + ctx.ajax : + ctx.sAjaxSource; + } + + // set + return this.iterator( 'table', function ( settings ) { + if ( $.isPlainObject( settings.ajax ) ) { + settings.ajax.url = url; + } + else { + settings.ajax = url; + } + // No need to consider sAjaxSource here since DataTables gives priority + // to `ajax` over `sAjaxSource`. So setting `ajax` here, renders any + // value of `sAjaxSource` redundant. + } ); + } ); + + + /** + * Load data from the newly set Ajax URL. Note that this method is only + * available when `ajax.url()` is used to set a URL. Additionally, this method + * has the same effect as calling `ajax.reload()` but is provided for + * convenience when setting a new URL. Like `ajax.reload()` it will + * automatically redraw the table once the remote data has been loaded. + * + * @returns {DataTables.Api} this + */ + _api_register( 'ajax.url().load()', function ( callback, resetPaging ) { + // Same as a reload, but makes sense to present it for easy access after a + // url change + return this.iterator( 'table', function ( ctx ) { + __reload( ctx, resetPaging===false, callback ); + } ); + } ); + + + + + var _selector_run = function ( type, selector, selectFn, settings, opts ) + { + var + out = [], res, + a, i, ien, j, jen, + selectorType = typeof selector; + + // Can't just check for isArray here, as an API or jQuery instance might be + // given with their array like look + if ( ! selector || selectorType === 'string' || selectorType === 'function' || selector.length === undefined ) { + selector = [ selector ]; + } + + for ( i=0, ien=selector.length ; i<ien ; i++ ) { + // Only split on simple strings - complex expressions will be jQuery selectors + a = selector[i] && selector[i].split && ! selector[i].match(/[\[\(:]/) ? + selector[i].split(',') : + [ selector[i] ]; + + for ( j=0, jen=a.length ; j<jen ; j++ ) { + res = selectFn( typeof a[j] === 'string' ? (a[j]).trim() : a[j] ); + + if ( res && res.length ) { + out = out.concat( res ); + } + } + } + + // selector extensions + var ext = _ext.selector[ type ]; + if ( ext.length ) { + for ( i=0, ien=ext.length ; i<ien ; i++ ) { + out = ext[i]( settings, opts, out ); + } + } + + return _unique( out ); + }; + + + var _selector_opts = function ( opts ) + { + if ( ! opts ) { + opts = {}; + } + + // Backwards compatibility for 1.9- which used the terminology filter rather + // than search + if ( opts.filter && opts.search === undefined ) { + opts.search = opts.filter; + } + + return $.extend( { + search: 'none', + order: 'current', + page: 'all' + }, opts ); + }; + + + var _selector_first = function ( inst ) + { + // Reduce the API instance to the first item found + for ( var i=0, ien=inst.length ; i<ien ; i++ ) { + if ( inst[i].length > 0 ) { + // Assign the first element to the first item in the instance + // and truncate the instance and context + inst[0] = inst[i]; + inst[0].length = 1; + inst.length = 1; + inst.context = [ inst.context[i] ]; + + return inst; + } + } + + // Not found - return an empty instance + inst.length = 0; + return inst; + }; + + + var _selector_row_indexes = function ( settings, opts ) + { + var + i, ien, tmp, a=[], + displayFiltered = settings.aiDisplay, + displayMaster = settings.aiDisplayMaster; + + var + search = opts.search, // none, applied, removed + order = opts.order, // applied, current, index (original - compatibility with 1.9) + page = opts.page; // all, current + + if ( _fnDataSource( settings ) == 'ssp' ) { + // In server-side processing mode, most options are irrelevant since + // rows not shown don't exist and the index order is the applied order + // Removed is a special case - for consistency just return an empty + // array + return search === 'removed' ? + [] : + _range( 0, displayMaster.length ); + } + else if ( page == 'current' ) { + // Current page implies that order=current and filter=applied, since it is + // fairly senseless otherwise, regardless of what order and search actually + // are + for ( i=settings._iDisplayStart, ien=settings.fnDisplayEnd() ; i<ien ; i++ ) { + a.push( displayFiltered[i] ); + } + } + else if ( order == 'current' || order == 'applied' ) { + if ( search == 'none') { + a = displayMaster.slice(); + } + else if ( search == 'applied' ) { + a = displayFiltered.slice(); + } + else if ( search == 'removed' ) { + // O(n+m) solution by creating a hash map + var displayFilteredMap = {}; + + for ( var i=0, ien=displayFiltered.length ; i<ien ; i++ ) { + displayFilteredMap[displayFiltered[i]] = null; + } + + a = $.map( displayMaster, function (el) { + return ! displayFilteredMap.hasOwnProperty(el) ? + el : + null; + } ); + } + } + else if ( order == 'index' || order == 'original' ) { + for ( i=0, ien=settings.aoData.length ; i<ien ; i++ ) { + if ( search == 'none' ) { + a.push( i ); + } + else { // applied | removed + tmp = $.inArray( i, displayFiltered ); + + if ((tmp === -1 && search == 'removed') || + (tmp >= 0 && search == 'applied') ) + { + a.push( i ); + } + } + } + } + + return a; + }; + + + /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Rows + * + * {} - no selector - use all available rows + * {integer} - row aoData index + * {node} - TR node + * {string} - jQuery selector to apply to the TR elements + * {array} - jQuery array of nodes, or simply an array of TR nodes + * + */ + var __row_selector = function ( settings, selector, opts ) + { + var rows; + var run = function ( sel ) { + var selInt = _intVal( sel ); + var i, ien; + var aoData = settings.aoData; + + // Short cut - selector is a number and no options provided (default is + // all records, so no need to check if the index is in there, since it + // must be - dev error if the index doesn't exist). + if ( selInt !== null && ! opts ) { + return [ selInt ]; + } + + if ( ! rows ) { + rows = _selector_row_indexes( settings, opts ); + } + + if ( selInt !== null && $.inArray( selInt, rows ) !== -1 ) { + // Selector - integer + return [ selInt ]; + } + else if ( sel === null || sel === undefined || sel === '' ) { + // Selector - none + return rows; + } + + // Selector - function + if ( typeof sel === 'function' ) { + return $.map( rows, function (idx) { + var row = aoData[ idx ]; + return sel( idx, row._aData, row.nTr ) ? idx : null; + } ); + } + + // Selector - node + if ( sel.nodeName ) { + var rowIdx = sel._DT_RowIndex; // Property added by DT for fast lookup + var cellIdx = sel._DT_CellIndex; + + if ( rowIdx !== undefined ) { + // Make sure that the row is actually still present in the table + return aoData[ rowIdx ] && aoData[ rowIdx ].nTr === sel ? + [ rowIdx ] : + []; + } + else if ( cellIdx ) { + return aoData[ cellIdx.row ] && aoData[ cellIdx.row ].nTr === sel.parentNode ? + [ cellIdx.row ] : + []; + } + else { + var host = $(sel).closest('*[data-dt-row]'); + return host.length ? + [ host.data('dt-row') ] : + []; + } + } + + // ID selector. Want to always be able to select rows by id, regardless + // of if the tr element has been created or not, so can't rely upon + // jQuery here - hence a custom implementation. This does not match + // Sizzle's fast selector or HTML4 - in HTML5 the ID can be anything, + // but to select it using a CSS selector engine (like Sizzle or + // querySelect) it would need to need to be escaped for some characters. + // DataTables simplifies this for row selectors since you can select + // only a row. A # indicates an id any anything that follows is the id - + // unescaped. + if ( typeof sel === 'string' && sel.charAt(0) === '#' ) { + // get row index from id + var rowObj = settings.aIds[ sel.replace( /^#/, '' ) ]; + if ( rowObj !== undefined ) { + return [ rowObj.idx ]; + } + + // need to fall through to jQuery in case there is DOM id that + // matches + } + + // Get nodes in the order from the `rows` array with null values removed + var nodes = _removeEmpty( + _pluck_order( settings.aoData, rows, 'nTr' ) + ); + + // Selector - jQuery selector string, array of nodes or jQuery object/ + // As jQuery's .filter() allows jQuery objects to be passed in filter, + // it also allows arrays, so this will cope with all three options + return $(nodes) + .filter( sel ) + .map( function () { + return this._DT_RowIndex; + } ) + .toArray(); + }; + + return _selector_run( 'row', selector, run, settings, opts ); + }; + + + _api_register( 'rows()', function ( selector, opts ) { + // argument shifting + if ( selector === undefined ) { + selector = ''; + } + else if ( $.isPlainObject( selector ) ) { + opts = selector; + selector = ''; + } + + opts = _selector_opts( opts ); + + var inst = this.iterator( 'table', function ( settings ) { + return __row_selector( settings, selector, opts ); + }, 1 ); + + // Want argument shifting here and in __row_selector? + inst.selector.rows = selector; + inst.selector.opts = opts; + + return inst; + } ); + + _api_register( 'rows().nodes()', function () { + return this.iterator( 'row', function ( settings, row ) { + return settings.aoData[ row ].nTr || undefined; + }, 1 ); + } ); + + _api_register( 'rows().data()', function () { + return this.iterator( true, 'rows', function ( settings, rows ) { + return _pluck_order( settings.aoData, rows, '_aData' ); + }, 1 ); + } ); + + _api_registerPlural( 'rows().cache()', 'row().cache()', function ( type ) { + return this.iterator( 'row', function ( settings, row ) { + var r = settings.aoData[ row ]; + return type === 'search' ? r._aFilterData : r._aSortData; + }, 1 ); + } ); + + _api_registerPlural( 'rows().invalidate()', 'row().invalidate()', function ( src ) { + return this.iterator( 'row', function ( settings, row ) { + _fnInvalidate( settings, row, src ); + } ); + } ); + + _api_registerPlural( 'rows().indexes()', 'row().index()', function () { + return this.iterator( 'row', function ( settings, row ) { + return row; + }, 1 ); + } ); + + _api_registerPlural( 'rows().ids()', 'row().id()', function ( hash ) { + var a = []; + var context = this.context; + + // `iterator` will drop undefined values, but in this case we want them + for ( var i=0, ien=context.length ; i<ien ; i++ ) { + for ( var j=0, jen=this[i].length ; j<jen ; j++ ) { + var id = context[i].rowIdFn( context[i].aoData[ this[i][j] ]._aData ); + a.push( (hash === true ? '#' : '' )+ id ); + } + } + + return new _Api( context, a ); + } ); + + _api_registerPlural( 'rows().remove()', 'row().remove()', function () { + var that = this; + + this.iterator( 'row', function ( settings, row, thatIdx ) { + var data = settings.aoData; + var rowData = data[ row ]; + var i, ien, j, jen; + var loopRow, loopCells; + + data.splice( row, 1 ); + + // Update the cached indexes + for ( i=0, ien=data.length ; i<ien ; i++ ) { + loopRow = data[i]; + loopCells = loopRow.anCells; + + // Rows + if ( loopRow.nTr !== null ) { + loopRow.nTr._DT_RowIndex = i; + } + + // Cells + if ( loopCells !== null ) { + for ( j=0, jen=loopCells.length ; j<jen ; j++ ) { + loopCells[j]._DT_CellIndex.row = i; + } + } + } + + // Delete from the display arrays + _fnDeleteIndex( settings.aiDisplayMaster, row ); + _fnDeleteIndex( settings.aiDisplay, row ); + _fnDeleteIndex( that[ thatIdx ], row, false ); // maintain local indexes + + // For server-side processing tables - subtract the deleted row from the count + if ( settings._iRecordsDisplay > 0 ) { + settings._iRecordsDisplay--; + } + + // Check for an 'overflow' they case for displaying the table + _fnLengthOverflow( settings ); + + // Remove the row's ID reference if there is one + var id = settings.rowIdFn( rowData._aData ); + if ( id !== undefined ) { + delete settings.aIds[ id ]; + } + } ); + + this.iterator( 'table', function ( settings ) { + for ( var i=0, ien=settings.aoData.length ; i<ien ; i++ ) { + settings.aoData[i].idx = i; + } + } ); + + return this; + } ); + + + _api_register( 'rows.add()', function ( rows ) { + var newRows = this.iterator( 'table', function ( settings ) { + var row, i, ien; + var out = []; + + for ( i=0, ien=rows.length ; i<ien ; i++ ) { + row = rows[i]; + + if ( row.nodeName && row.nodeName.toUpperCase() === 'TR' ) { + out.push( _fnAddTr( settings, row )[0] ); + } + else { + out.push( _fnAddData( settings, row ) ); + } + } + + return out; + }, 1 ); + + // Return an Api.rows() extended instance, so rows().nodes() etc can be used + var modRows = this.rows( -1 ); + modRows.pop(); + $.merge( modRows, newRows ); + + return modRows; + } ); + + + + + + /** + * + */ + _api_register( 'row()', function ( selector, opts ) { + return _selector_first( this.rows( selector, opts ) ); + } ); + + + _api_register( 'row().data()', function ( data ) { + var ctx = this.context; + + if ( data === undefined ) { + // Get + return ctx.length && this.length ? + ctx[0].aoData[ this[0] ]._aData : + undefined; + } + + // Set + var row = ctx[0].aoData[ this[0] ]; + row._aData = data; + + // If the DOM has an id, and the data source is an array + if ( Array.isArray( data ) && row.nTr && row.nTr.id ) { + _fnSetObjectDataFn( ctx[0].rowId )( data, row.nTr.id ); + } + + // Automatically invalidate + _fnInvalidate( ctx[0], this[0], 'data' ); + + return this; + } ); + + + _api_register( 'row().node()', function () { + var ctx = this.context; + + return ctx.length && this.length ? + ctx[0].aoData[ this[0] ].nTr || null : + null; + } ); + + + _api_register( 'row.add()', function ( row ) { + // Allow a jQuery object to be passed in - only a single row is added from + // it though - the first element in the set + if ( row instanceof $ && row.length ) { + row = row[0]; + } + + var rows = this.iterator( 'table', function ( settings ) { + if ( row.nodeName && row.nodeName.toUpperCase() === 'TR' ) { + return _fnAddTr( settings, row )[0]; + } + return _fnAddData( settings, row ); + } ); + + // Return an Api.rows() extended instance, with the newly added row selected + return this.row( rows[0] ); + } ); + + + $(document).on('plugin-init.dt', function (e, context) { + var api = new _Api( context ); + + api.on( 'stateSaveParams', function ( e, settings, d ) { + // This could be more compact with the API, but it is a lot faster as a simple + // internal loop + var idFn = settings.rowIdFn; + var data = settings.aoData; + var ids = []; + + for (var i=0 ; i<data.length ; i++) { + if (data[i]._detailsShow) { + ids.push( '#' + idFn(data[i]._aData) ); + } + } + + d.childRows = ids; + }) + + var loaded = api.state.loaded(); + + if ( loaded && loaded.childRows ) { + api + .rows( $.map(loaded.childRows, function (id){ + return id.replace(/:/g, '\\:') + }) ) + .every( function () { + _fnCallbackFire( context, null, 'requestChild', [ this ] ) + }); + } + }); + + var __details_add = function ( ctx, row, data, klass ) + { + // Convert to array of TR elements + var rows = []; + var addRow = function ( r, k ) { + // Recursion to allow for arrays of jQuery objects + if ( Array.isArray( r ) || r instanceof $ ) { + for ( var i=0, ien=r.length ; i<ien ; i++ ) { + addRow( r[i], k ); + } + return; + } + + // If we get a TR element, then just add it directly - up to the dev + // to add the correct number of columns etc + if ( r.nodeName && r.nodeName.toLowerCase() === 'tr' ) { + rows.push( r ); + } + else { + // Otherwise create a row with a wrapper + var created = $('<tr><td></td></tr>').addClass( k ); + $('td', created) + .addClass( k ) + .html( r ) + [0].colSpan = _fnVisbleColumns( ctx ); + + rows.push( created[0] ); + } + }; + + addRow( data, klass ); + + if ( row._details ) { + row._details.detach(); + } + + row._details = $(rows); + + // If the children were already shown, that state should be retained + if ( row._detailsShow ) { + row._details.insertAfter( row.nTr ); + } + }; + + + // Make state saving of child row details async to allow them to be batch processed + var __details_state = DataTable.util.throttle( + function (ctx) { + _fnSaveState( ctx[0] ) + }, + 500 + ); + + + var __details_remove = function ( api, idx ) + { + var ctx = api.context; + + if ( ctx.length ) { + var row = ctx[0].aoData[ idx !== undefined ? idx : api[0] ]; + + if ( row && row._details ) { + row._details.remove(); + + row._detailsShow = undefined; + row._details = undefined; + $( row.nTr ).removeClass( 'dt-hasChild' ); + __details_state( ctx ); + } + } + }; + + + var __details_display = function ( api, show ) { + var ctx = api.context; + + if ( ctx.length && api.length ) { + var row = ctx[0].aoData[ api[0] ]; + + if ( row._details ) { + row._detailsShow = show; + + if ( show ) { + row._details.insertAfter( row.nTr ); + $( row.nTr ).addClass( 'dt-hasChild' ); + } + else { + row._details.detach(); + $( row.nTr ).removeClass( 'dt-hasChild' ); + } + + _fnCallbackFire( ctx[0], null, 'childRow', [ show, api.row( api[0] ) ] ) + + __details_events( ctx[0] ); + __details_state( ctx ); + } + } + }; + + + var __details_events = function ( settings ) + { + var api = new _Api( settings ); + var namespace = '.dt.DT_details'; + var drawEvent = 'draw'+namespace; + var colvisEvent = 'column-visibility'+namespace; + var destroyEvent = 'destroy'+namespace; + var data = settings.aoData; + + api.off( drawEvent +' '+ colvisEvent +' '+ destroyEvent ); + + if ( _pluck( data, '_details' ).length > 0 ) { + // On each draw, insert the required elements into the document + api.on( drawEvent, function ( e, ctx ) { + if ( settings !== ctx ) { + return; + } + + api.rows( {page:'current'} ).eq(0).each( function (idx) { + // Internal data grab + var row = data[ idx ]; + + if ( row._detailsShow ) { + row._details.insertAfter( row.nTr ); + } + } ); + } ); + + // Column visibility change - update the colspan + api.on( colvisEvent, function ( e, ctx, idx, vis ) { + if ( settings !== ctx ) { + return; + } + + // Update the colspan for the details rows (note, only if it already has + // a colspan) + var row, visible = _fnVisbleColumns( ctx ); + + for ( var i=0, ien=data.length ; i<ien ; i++ ) { + row = data[i]; + + if ( row._details ) { + row._details.children('td[colspan]').attr('colspan', visible ); + } + } + } ); + + // Table destroyed - nuke any child rows + api.on( destroyEvent, function ( e, ctx ) { + if ( settings !== ctx ) { + return; + } + + for ( var i=0, ien=data.length ; i<ien ; i++ ) { + if ( data[i]._details ) { + __details_remove( api, i ); + } + } + } ); + } + }; + + // Strings for the method names to help minification + var _emp = ''; + var _child_obj = _emp+'row().child'; + var _child_mth = _child_obj+'()'; + + // data can be: + // tr + // string + // jQuery or array of any of the above + _api_register( _child_mth, function ( data, klass ) { + var ctx = this.context; + + if ( data === undefined ) { + // get + return ctx.length && this.length ? + ctx[0].aoData[ this[0] ]._details : + undefined; + } + else if ( data === true ) { + // show + this.child.show(); + } + else if ( data === false ) { + // remove + __details_remove( this ); + } + else if ( ctx.length && this.length ) { + // set + __details_add( ctx[0], ctx[0].aoData[ this[0] ], data, klass ); + } + + return this; + } ); + + + _api_register( [ + _child_obj+'.show()', + _child_mth+'.show()' // only when `child()` was called with parameters (without + ], function ( show ) { // it returns an object and this method is not executed) + __details_display( this, true ); + return this; + } ); + + + _api_register( [ + _child_obj+'.hide()', + _child_mth+'.hide()' // only when `child()` was called with parameters (without + ], function () { // it returns an object and this method is not executed) + __details_display( this, false ); + return this; + } ); + + + _api_register( [ + _child_obj+'.remove()', + _child_mth+'.remove()' // only when `child()` was called with parameters (without + ], function () { // it returns an object and this method is not executed) + __details_remove( this ); + return this; + } ); + + + _api_register( _child_obj+'.isShown()', function () { + var ctx = this.context; + + if ( ctx.length && this.length ) { + // _detailsShown as false or undefined will fall through to return false + return ctx[0].aoData[ this[0] ]._detailsShow || false; + } + return false; + } ); + + + + /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Columns + * + * {integer} - column index (>=0 count from left, <0 count from right) + * "{integer}:visIdx" - visible column index (i.e. translate to column index) (>=0 count from left, <0 count from right) + * "{integer}:visible" - alias for {integer}:visIdx (>=0 count from left, <0 count from right) + * "{string}:name" - column name + * "{string}" - jQuery selector on column header nodes + * + */ + + // can be an array of these items, comma separated list, or an array of comma + // separated lists + + var __re_column_selector = /^([^:]+):(name|visIdx|visible)$/; + + + // r1 and r2 are redundant - but it means that the parameters match for the + // iterator callback in columns().data() + var __columnData = function ( settings, column, r1, r2, rows ) { + var a = []; + for ( var row=0, ien=rows.length ; row<ien ; row++ ) { + a.push( _fnGetCellData( settings, rows[row], column ) ); + } + return a; + }; + + + var __column_selector = function ( settings, selector, opts ) + { + var + columns = settings.aoColumns, + names = _pluck( columns, 'sName' ), + nodes = _pluck( columns, 'nTh' ); + + var run = function ( s ) { + var selInt = _intVal( s ); + + // Selector - all + if ( s === '' ) { + return _range( columns.length ); + } + + // Selector - index + if ( selInt !== null ) { + return [ selInt >= 0 ? + selInt : // Count from left + columns.length + selInt // Count from right (+ because its a negative value) + ]; + } + + // Selector = function + if ( typeof s === 'function' ) { + var rows = _selector_row_indexes( settings, opts ); + + return $.map( columns, function (col, idx) { + return s( + idx, + __columnData( settings, idx, 0, 0, rows ), + nodes[ idx ] + ) ? idx : null; + } ); + } + + // jQuery or string selector + var match = typeof s === 'string' ? + s.match( __re_column_selector ) : + ''; + + if ( match ) { + switch( match[2] ) { + case 'visIdx': + case 'visible': + var idx = parseInt( match[1], 10 ); + // Visible index given, convert to column index + if ( idx < 0 ) { + // Counting from the right + var visColumns = $.map( columns, function (col,i) { + return col.bVisible ? i : null; + } ); + return [ visColumns[ visColumns.length + idx ] ]; + } + // Counting from the left + return [ _fnVisibleToColumnIndex( settings, idx ) ]; + + case 'name': + // match by name. `names` is column index complete and in order + return $.map( names, function (name, i) { + return name === match[1] ? i : null; + } ); + + default: + return []; + } + } + + // Cell in the table body + if ( s.nodeName && s._DT_CellIndex ) { + return [ s._DT_CellIndex.column ]; + } + + // jQuery selector on the TH elements for the columns + var jqResult = $( nodes ) + .filter( s ) + .map( function () { + return $.inArray( this, nodes ); // `nodes` is column index complete and in order + } ) + .toArray(); + + if ( jqResult.length || ! s.nodeName ) { + return jqResult; + } + + // Otherwise a node which might have a `dt-column` data attribute, or be + // a child or such an element + var host = $(s).closest('*[data-dt-column]'); + return host.length ? + [ host.data('dt-column') ] : + []; + }; + + return _selector_run( 'column', selector, run, settings, opts ); + }; + + + var __setColumnVis = function ( settings, column, vis ) { + var + cols = settings.aoColumns, + col = cols[ column ], + data = settings.aoData, + row, cells, i, ien, tr; + + // Get + if ( vis === undefined ) { + return col.bVisible; + } + + // Set + // No change + if ( col.bVisible === vis ) { + return; + } + + if ( vis ) { + // Insert column + // Need to decide if we should use appendChild or insertBefore + var insertBefore = $.inArray( true, _pluck(cols, 'bVisible'), column+1 ); + + for ( i=0, ien=data.length ; i<ien ; i++ ) { + tr = data[i].nTr; + cells = data[i].anCells; + + if ( tr ) { + // insertBefore can act like appendChild if 2nd arg is null + tr.insertBefore( cells[ column ], cells[ insertBefore ] || null ); + } + } + } + else { + // Remove column + $( _pluck( settings.aoData, 'anCells', column ) ).detach(); + } + + // Common actions + col.bVisible = vis; + }; + + + _api_register( 'columns()', function ( selector, opts ) { + // argument shifting + if ( selector === undefined ) { + selector = ''; + } + else if ( $.isPlainObject( selector ) ) { + opts = selector; + selector = ''; + } + + opts = _selector_opts( opts ); + + var inst = this.iterator( 'table', function ( settings ) { + return __column_selector( settings, selector, opts ); + }, 1 ); + + // Want argument shifting here and in _row_selector? + inst.selector.cols = selector; + inst.selector.opts = opts; + + return inst; + } ); + + _api_registerPlural( 'columns().header()', 'column().header()', function ( selector, opts ) { + return this.iterator( 'column', function ( settings, column ) { + return settings.aoColumns[column].nTh; + }, 1 ); + } ); + + _api_registerPlural( 'columns().footer()', 'column().footer()', function ( selector, opts ) { + return this.iterator( 'column', function ( settings, column ) { + return settings.aoColumns[column].nTf; + }, 1 ); + } ); + + _api_registerPlural( 'columns().data()', 'column().data()', function () { + return this.iterator( 'column-rows', __columnData, 1 ); + } ); + + _api_registerPlural( 'columns().dataSrc()', 'column().dataSrc()', function () { + return this.iterator( 'column', function ( settings, column ) { + return settings.aoColumns[column].mData; + }, 1 ); + } ); + + _api_registerPlural( 'columns().cache()', 'column().cache()', function ( type ) { + return this.iterator( 'column-rows', function ( settings, column, i, j, rows ) { + return _pluck_order( settings.aoData, rows, + type === 'search' ? '_aFilterData' : '_aSortData', column + ); + }, 1 ); + } ); + + _api_registerPlural( 'columns().nodes()', 'column().nodes()', function () { + return this.iterator( 'column-rows', function ( settings, column, i, j, rows ) { + return _pluck_order( settings.aoData, rows, 'anCells', column ) ; + }, 1 ); + } ); + + _api_registerPlural( 'columns().visible()', 'column().visible()', function ( vis, calc ) { + var that = this; + var ret = this.iterator( 'column', function ( settings, column ) { + if ( vis === undefined ) { + return settings.aoColumns[ column ].bVisible; + } // else + __setColumnVis( settings, column, vis ); + } ); + + // Group the column visibility changes + if ( vis !== undefined ) { + this.iterator( 'table', function ( settings ) { + // Redraw the header after changes + _fnDrawHead( settings, settings.aoHeader ); + _fnDrawHead( settings, settings.aoFooter ); + + // Update colspan for no records display. Child rows and extensions will use their own + // listeners to do this - only need to update the empty table item here + if ( ! settings.aiDisplay.length ) { + $(settings.nTBody).find('td[colspan]').attr('colspan', _fnVisbleColumns(settings)); + } + + _fnSaveState( settings ); + + // Second loop once the first is done for events + that.iterator( 'column', function ( settings, column ) { + _fnCallbackFire( settings, null, 'column-visibility', [settings, column, vis, calc] ); + } ); + + if ( calc === undefined || calc ) { + that.columns.adjust(); + } + }); + } + + return ret; + } ); + + _api_registerPlural( 'columns().indexes()', 'column().index()', function ( type ) { + return this.iterator( 'column', function ( settings, column ) { + return type === 'visible' ? + _fnColumnIndexToVisible( settings, column ) : + column; + }, 1 ); + } ); + + _api_register( 'columns.adjust()', function () { + return this.iterator( 'table', function ( settings ) { + _fnAdjustColumnSizing( settings ); + }, 1 ); + } ); + + _api_register( 'column.index()', function ( type, idx ) { + if ( this.context.length !== 0 ) { + var ctx = this.context[0]; + + if ( type === 'fromVisible' || type === 'toData' ) { + return _fnVisibleToColumnIndex( ctx, idx ); + } + else if ( type === 'fromData' || type === 'toVisible' ) { + return _fnColumnIndexToVisible( ctx, idx ); + } + } + } ); + + _api_register( 'column()', function ( selector, opts ) { + return _selector_first( this.columns( selector, opts ) ); + } ); + + var __cell_selector = function ( settings, selector, opts ) + { + var data = settings.aoData; + var rows = _selector_row_indexes( settings, opts ); + var cells = _removeEmpty( _pluck_order( data, rows, 'anCells' ) ); + var allCells = $(_flatten( [], cells )); + var row; + var columns = settings.aoColumns.length; + var a, i, ien, j, o, host; + + var run = function ( s ) { + var fnSelector = typeof s === 'function'; + + if ( s === null || s === undefined || fnSelector ) { + // All cells and function selectors + a = []; + + for ( i=0, ien=rows.length ; i<ien ; i++ ) { + row = rows[i]; + + for ( j=0 ; j<columns ; j++ ) { + o = { + row: row, + column: j + }; + + if ( fnSelector ) { + // Selector - function + host = data[ row ]; + + if ( s( o, _fnGetCellData(settings, row, j), host.anCells ? host.anCells[j] : null ) ) { + a.push( o ); + } + } + else { + // Selector - all + a.push( o ); + } + } + } + + return a; + } + + // Selector - index + if ( $.isPlainObject( s ) ) { + // Valid cell index and its in the array of selectable rows + return s.column !== undefined && s.row !== undefined && $.inArray( s.row, rows ) !== -1 ? + [s] : + []; + } + + // Selector - jQuery filtered cells + var jqResult = allCells + .filter( s ) + .map( function (i, el) { + return { // use a new object, in case someone changes the values + row: el._DT_CellIndex.row, + column: el._DT_CellIndex.column + }; + } ) + .toArray(); + + if ( jqResult.length || ! s.nodeName ) { + return jqResult; + } + + // Otherwise the selector is a node, and there is one last option - the + // element might be a child of an element which has dt-row and dt-column + // data attributes + host = $(s).closest('*[data-dt-row]'); + return host.length ? + [ { + row: host.data('dt-row'), + column: host.data('dt-column') + } ] : + []; + }; + + return _selector_run( 'cell', selector, run, settings, opts ); + }; + + + + + _api_register( 'cells()', function ( rowSelector, columnSelector, opts ) { + // Argument shifting + if ( $.isPlainObject( rowSelector ) ) { + // Indexes + if ( rowSelector.row === undefined ) { + // Selector options in first parameter + opts = rowSelector; + rowSelector = null; + } + else { + // Cell index objects in first parameter + opts = columnSelector; + columnSelector = null; + } + } + if ( $.isPlainObject( columnSelector ) ) { + opts = columnSelector; + columnSelector = null; + } + + // Cell selector + if ( columnSelector === null || columnSelector === undefined ) { + return this.iterator( 'table', function ( settings ) { + return __cell_selector( settings, rowSelector, _selector_opts( opts ) ); + } ); + } + + // The default built in options need to apply to row and columns + var internalOpts = opts ? { + page: opts.page, + order: opts.order, + search: opts.search + } : {}; + + // Row + column selector + var columns = this.columns( columnSelector, internalOpts ); + var rows = this.rows( rowSelector, internalOpts ); + var i, ien, j, jen; + + var cellsNoOpts = this.iterator( 'table', function ( settings, idx ) { + var a = []; + + for ( i=0, ien=rows[idx].length ; i<ien ; i++ ) { + for ( j=0, jen=columns[idx].length ; j<jen ; j++ ) { + a.push( { + row: rows[idx][i], + column: columns[idx][j] + } ); + } + } + + return a; + }, 1 ); + + // There is currently only one extension which uses a cell selector extension + // It is a _major_ performance drag to run this if it isn't needed, so this is + // an extension specific check at the moment + var cells = opts && opts.selected ? + this.cells( cellsNoOpts, opts ) : + cellsNoOpts; + + $.extend( cells.selector, { + cols: columnSelector, + rows: rowSelector, + opts: opts + } ); + + return cells; + } ); + + + _api_registerPlural( 'cells().nodes()', 'cell().node()', function () { + return this.iterator( 'cell', function ( settings, row, column ) { + var data = settings.aoData[ row ]; + + return data && data.anCells ? + data.anCells[ column ] : + undefined; + }, 1 ); + } ); + + + _api_register( 'cells().data()', function () { + return this.iterator( 'cell', function ( settings, row, column ) { + return _fnGetCellData( settings, row, column ); + }, 1 ); + } ); + + + _api_registerPlural( 'cells().cache()', 'cell().cache()', function ( type ) { + type = type === 'search' ? '_aFilterData' : '_aSortData'; + + return this.iterator( 'cell', function ( settings, row, column ) { + return settings.aoData[ row ][ type ][ column ]; + }, 1 ); + } ); + + + _api_registerPlural( 'cells().render()', 'cell().render()', function ( type ) { + return this.iterator( 'cell', function ( settings, row, column ) { + return _fnGetCellData( settings, row, column, type ); + }, 1 ); + } ); + + + _api_registerPlural( 'cells().indexes()', 'cell().index()', function () { + return this.iterator( 'cell', function ( settings, row, column ) { + return { + row: row, + column: column, + columnVisible: _fnColumnIndexToVisible( settings, column ) + }; + }, 1 ); + } ); + + + _api_registerPlural( 'cells().invalidate()', 'cell().invalidate()', function ( src ) { + return this.iterator( 'cell', function ( settings, row, column ) { + _fnInvalidate( settings, row, src, column ); + } ); + } ); + + + + _api_register( 'cell()', function ( rowSelector, columnSelector, opts ) { + return _selector_first( this.cells( rowSelector, columnSelector, opts ) ); + } ); + + + _api_register( 'cell().data()', function ( data ) { + var ctx = this.context; + var cell = this[0]; + + if ( data === undefined ) { + // Get + return ctx.length && cell.length ? + _fnGetCellData( ctx[0], cell[0].row, cell[0].column ) : + undefined; + } + + // Set + _fnSetCellData( ctx[0], cell[0].row, cell[0].column, data ); + _fnInvalidate( ctx[0], cell[0].row, 'data', cell[0].column ); + + return this; + } ); + + + + /** + * Get current ordering (sorting) that has been applied to the table. + * + * @returns {array} 2D array containing the sorting information for the first + * table in the current context. Each element in the parent array represents + * a column being sorted upon (i.e. multi-sorting with two columns would have + * 2 inner arrays). The inner arrays may have 2 or 3 elements. The first is + * the column index that the sorting condition applies to, the second is the + * direction of the sort (`desc` or `asc`) and, optionally, the third is the + * index of the sorting order from the `column.sorting` initialisation array. + *//** + * Set the ordering for the table. + * + * @param {integer} order Column index to sort upon. + * @param {string} direction Direction of the sort to be applied (`asc` or `desc`) + * @returns {DataTables.Api} this + *//** + * Set the ordering for the table. + * + * @param {array} order 1D array of sorting information to be applied. + * @param {array} [...] Optional additional sorting conditions + * @returns {DataTables.Api} this + *//** + * Set the ordering for the table. + * + * @param {array} order 2D array of sorting information to be applied. + * @returns {DataTables.Api} this + */ + _api_register( 'order()', function ( order, dir ) { + var ctx = this.context; + + if ( order === undefined ) { + // get + return ctx.length !== 0 ? + ctx[0].aaSorting : + undefined; + } + + // set + if ( typeof order === 'number' ) { + // Simple column / direction passed in + order = [ [ order, dir ] ]; + } + else if ( order.length && ! Array.isArray( order[0] ) ) { + // Arguments passed in (list of 1D arrays) + order = Array.prototype.slice.call( arguments ); + } + // otherwise a 2D array was passed in + + return this.iterator( 'table', function ( settings ) { + settings.aaSorting = order.slice(); + } ); + } ); + + + /** + * Attach a sort listener to an element for a given column + * + * @param {node|jQuery|string} node Identifier for the element(s) to attach the + * listener to. This can take the form of a single DOM node, a jQuery + * collection of nodes or a jQuery selector which will identify the node(s). + * @param {integer} column the column that a click on this node will sort on + * @param {function} [callback] callback function when sort is run + * @returns {DataTables.Api} this + */ + _api_register( 'order.listener()', function ( node, column, callback ) { + return this.iterator( 'table', function ( settings ) { + _fnSortAttachListener( settings, node, column, callback ); + } ); + } ); + + + _api_register( 'order.fixed()', function ( set ) { + if ( ! set ) { + var ctx = this.context; + var fixed = ctx.length ? + ctx[0].aaSortingFixed : + undefined; + + return Array.isArray( fixed ) ? + { pre: fixed } : + fixed; + } + + return this.iterator( 'table', function ( settings ) { + settings.aaSortingFixed = $.extend( true, {}, set ); + } ); + } ); + + + // Order by the selected column(s) + _api_register( [ + 'columns().order()', + 'column().order()' + ], function ( dir ) { + var that = this; + + return this.iterator( 'table', function ( settings, i ) { + var sort = []; + + $.each( that[i], function (j, col) { + sort.push( [ col, dir ] ); + } ); + + settings.aaSorting = sort; + } ); + } ); + + + + _api_register( 'search()', function ( input, regex, smart, caseInsen ) { + var ctx = this.context; + + if ( input === undefined ) { + // get + return ctx.length !== 0 ? + ctx[0].oPreviousSearch.sSearch : + undefined; + } + + // set + return this.iterator( 'table', function ( settings ) { + if ( ! settings.oFeatures.bFilter ) { + return; + } + + _fnFilterComplete( settings, $.extend( {}, settings.oPreviousSearch, { + "sSearch": input+"", + "bRegex": regex === null ? false : regex, + "bSmart": smart === null ? true : smart, + "bCaseInsensitive": caseInsen === null ? true : caseInsen + } ), 1 ); + } ); + } ); + + + _api_registerPlural( + 'columns().search()', + 'column().search()', + function ( input, regex, smart, caseInsen ) { + return this.iterator( 'column', function ( settings, column ) { + var preSearch = settings.aoPreSearchCols; + + if ( input === undefined ) { + // get + return preSearch[ column ].sSearch; + } + + // set + if ( ! settings.oFeatures.bFilter ) { + return; + } + + $.extend( preSearch[ column ], { + "sSearch": input+"", + "bRegex": regex === null ? false : regex, + "bSmart": smart === null ? true : smart, + "bCaseInsensitive": caseInsen === null ? true : caseInsen + } ); + + _fnFilterComplete( settings, settings.oPreviousSearch, 1 ); + } ); + } + ); + + /* + * State API methods + */ + + _api_register( 'state()', function () { + return this.context.length ? + this.context[0].oSavedState : + null; + } ); + + + _api_register( 'state.clear()', function () { + return this.iterator( 'table', function ( settings ) { + // Save an empty object + settings.fnStateSaveCallback.call( settings.oInstance, settings, {} ); + } ); + } ); + + + _api_register( 'state.loaded()', function () { + return this.context.length ? + this.context[0].oLoadedState : + null; + } ); + + + _api_register( 'state.save()', function () { + return this.iterator( 'table', function ( settings ) { + _fnSaveState( settings ); + } ); + } ); + + + + /** + * Provide a common method for plug-ins to check the version of DataTables being + * used, in order to ensure compatibility. + * + * @param {string} version Version string to check for, in the format "X.Y.Z". + * Note that the formats "X" and "X.Y" are also acceptable. + * @returns {boolean} true if this version of DataTables is greater or equal to + * the required version, or false if this version of DataTales is not + * suitable + * @static + * @dtopt API-Static + * + * @example + * alert( $.fn.dataTable.versionCheck( '1.9.0' ) ); + */ + DataTable.versionCheck = DataTable.fnVersionCheck = function( version ) + { + var aThis = DataTable.version.split('.'); + var aThat = version.split('.'); + var iThis, iThat; + + for ( var i=0, iLen=aThat.length ; i<iLen ; i++ ) { + iThis = parseInt( aThis[i], 10 ) || 0; + iThat = parseInt( aThat[i], 10 ) || 0; + + // Parts are the same, keep comparing + if (iThis === iThat) { + continue; + } + + // Parts are different, return immediately + return iThis > iThat; + } + + return true; + }; + + + /** + * Check if a `<table>` node is a DataTable table already or not. + * + * @param {node|jquery|string} table Table node, jQuery object or jQuery + * selector for the table to test. Note that if more than more than one + * table is passed on, only the first will be checked + * @returns {boolean} true the table given is a DataTable, or false otherwise + * @static + * @dtopt API-Static + * + * @example + * if ( ! $.fn.DataTable.isDataTable( '#example' ) ) { + * $('#example').dataTable(); + * } + */ + DataTable.isDataTable = DataTable.fnIsDataTable = function ( table ) + { + var t = $(table).get(0); + var is = false; + + if ( table instanceof DataTable.Api ) { + return true; + } + + $.each( DataTable.settings, function (i, o) { + var head = o.nScrollHead ? $('table', o.nScrollHead)[0] : null; + var foot = o.nScrollFoot ? $('table', o.nScrollFoot)[0] : null; + + if ( o.nTable === t || head === t || foot === t ) { + is = true; + } + } ); + + return is; + }; + + + /** + * Get all DataTable tables that have been initialised - optionally you can + * select to get only currently visible tables. + * + * @param {boolean} [visible=false] Flag to indicate if you want all (default) + * or visible tables only. + * @returns {array} Array of `table` nodes (not DataTable instances) which are + * DataTables + * @static + * @dtopt API-Static + * + * @example + * $.each( $.fn.dataTable.tables(true), function () { + * $(table).DataTable().columns.adjust(); + * } ); + */ + DataTable.tables = DataTable.fnTables = function ( visible ) + { + var api = false; + + if ( $.isPlainObject( visible ) ) { + api = visible.api; + visible = visible.visible; + } + + var a = $.map( DataTable.settings, function (o) { + if ( !visible || (visible && $(o.nTable).is(':visible')) ) { + return o.nTable; + } + } ); + + return api ? + new _Api( a ) : + a; + }; + + + /** + * Convert from camel case parameters to Hungarian notation. This is made public + * for the extensions to provide the same ability as DataTables core to accept + * either the 1.9 style Hungarian notation, or the 1.10+ style camelCase + * parameters. + * + * @param {object} src The model object which holds all parameters that can be + * mapped. + * @param {object} user The object to convert from camel case to Hungarian. + * @param {boolean} force When set to `true`, properties which already have a + * Hungarian value in the `user` object will be overwritten. Otherwise they + * won't be. + */ + DataTable.camelToHungarian = _fnCamelToHungarian; + + + + /** + * + */ + _api_register( '$()', function ( selector, opts ) { + var + rows = this.rows( opts ).nodes(), // Get all rows + jqRows = $(rows); + + return $( [].concat( + jqRows.filter( selector ).toArray(), + jqRows.find( selector ).toArray() + ) ); + } ); + + + // jQuery functions to operate on the tables + $.each( [ 'on', 'one', 'off' ], function (i, key) { + _api_register( key+'()', function ( /* event, handler */ ) { + var args = Array.prototype.slice.call(arguments); + + // Add the `dt` namespace automatically if it isn't already present + args[0] = $.map( args[0].split( /\s/ ), function ( e ) { + return ! e.match(/\.dt\b/) ? + e+'.dt' : + e; + } ).join( ' ' ); + + var inst = $( this.tables().nodes() ); + inst[key].apply( inst, args ); + return this; + } ); + } ); + + + _api_register( 'clear()', function () { + return this.iterator( 'table', function ( settings ) { + _fnClearTable( settings ); + } ); + } ); + + + _api_register( 'settings()', function () { + return new _Api( this.context, this.context ); + } ); + + + _api_register( 'init()', function () { + var ctx = this.context; + return ctx.length ? ctx[0].oInit : null; + } ); + + + _api_register( 'data()', function () { + return this.iterator( 'table', function ( settings ) { + return _pluck( settings.aoData, '_aData' ); + } ).flatten(); + } ); + + + _api_register( 'destroy()', function ( remove ) { + remove = remove || false; + + return this.iterator( 'table', function ( settings ) { + var orig = settings.nTableWrapper.parentNode; + var classes = settings.oClasses; + var table = settings.nTable; + var tbody = settings.nTBody; + var thead = settings.nTHead; + var tfoot = settings.nTFoot; + var jqTable = $(table); + var jqTbody = $(tbody); + var jqWrapper = $(settings.nTableWrapper); + var rows = $.map( settings.aoData, function (r) { return r.nTr; } ); + var i, ien; + + // Flag to note that the table is currently being destroyed - no action + // should be taken + settings.bDestroying = true; + + // Fire off the destroy callbacks for plug-ins etc + _fnCallbackFire( settings, "aoDestroyCallback", "destroy", [settings] ); + + // If not being removed from the document, make all columns visible + if ( ! remove ) { + new _Api( settings ).columns().visible( true ); + } + + // Blitz all `DT` namespaced events (these are internal events, the + // lowercase, `dt` events are user subscribed and they are responsible + // for removing them + jqWrapper.off('.DT').find(':not(tbody *)').off('.DT'); + $(window).off('.DT-'+settings.sInstance); + + // When scrolling we had to break the table up - restore it + if ( table != thead.parentNode ) { + jqTable.children('thead').detach(); + jqTable.append( thead ); + } + + if ( tfoot && table != tfoot.parentNode ) { + jqTable.children('tfoot').detach(); + jqTable.append( tfoot ); + } + + settings.aaSorting = []; + settings.aaSortingFixed = []; + _fnSortingClasses( settings ); + + $( rows ).removeClass( settings.asStripeClasses.join(' ') ); + + $('th, td', thead).removeClass( classes.sSortable+' '+ + classes.sSortableAsc+' '+classes.sSortableDesc+' '+classes.sSortableNone + ); + + // Add the TR elements back into the table in their original order + jqTbody.children().detach(); + jqTbody.append( rows ); + + // Remove the DataTables generated nodes, events and classes + var removedMethod = remove ? 'remove' : 'detach'; + jqTable[ removedMethod ](); + jqWrapper[ removedMethod ](); + + // If we need to reattach the table to the document + if ( ! remove && orig ) { + // insertBefore acts like appendChild if !arg[1] + orig.insertBefore( table, settings.nTableReinsertBefore ); + + // Restore the width of the original table - was read from the style property, + // so we can restore directly to that + jqTable + .css( 'width', settings.sDestroyWidth ) + .removeClass( classes.sTable ); + + // If the were originally stripe classes - then we add them back here. + // Note this is not fool proof (for example if not all rows had stripe + // classes - but it's a good effort without getting carried away + ien = settings.asDestroyStripes.length; + + if ( ien ) { + jqTbody.children().each( function (i) { + $(this).addClass( settings.asDestroyStripes[i % ien] ); + } ); + } + } + + /* Remove the settings object from the settings array */ + var idx = $.inArray( settings, DataTable.settings ); + if ( idx !== -1 ) { + DataTable.settings.splice( idx, 1 ); + } + } ); + } ); + + + // Add the `every()` method for rows, columns and cells in a compact form + $.each( [ 'column', 'row', 'cell' ], function ( i, type ) { + _api_register( type+'s().every()', function ( fn ) { + var opts = this.selector.opts; + var api = this; + + return this.iterator( type, function ( settings, arg1, arg2, arg3, arg4 ) { + // Rows and columns: + // arg1 - index + // arg2 - table counter + // arg3 - loop counter + // arg4 - undefined + // Cells: + // arg1 - row index + // arg2 - column index + // arg3 - table counter + // arg4 - loop counter + fn.call( + api[ type ]( + arg1, + type==='cell' ? arg2 : opts, + type==='cell' ? opts : undefined + ), + arg1, arg2, arg3, arg4 + ); + } ); + } ); + } ); + + + // i18n method for extensions to be able to use the language object from the + // DataTable + _api_register( 'i18n()', function ( token, def, plural ) { + var ctx = this.context[0]; + var resolved = _fnGetObjectDataFn( token )( ctx.oLanguage ); + + if ( resolved === undefined ) { + resolved = def; + } + + if ( plural !== undefined && $.isPlainObject( resolved ) ) { + resolved = resolved[ plural ] !== undefined ? + resolved[ plural ] : + resolved._; + } + + return resolved.replace( '%d', plural ); // nb: plural might be undefined, + } ); + /** + * Version string for plug-ins to check compatibility. Allowed format is + * `a.b.c-d` where: a:int, b:int, c:int, d:string(dev|beta|alpha). `d` is used + * only for non-release builds. See http://semver.org/ for more information. + * @member + * @type string + * @default Version number + */ + DataTable.version = "1.11.5"; + + /** + * Private data store, containing all of the settings objects that are + * created for the tables on a given page. + * + * Note that the `DataTable.settings` object is aliased to + * `jQuery.fn.dataTableExt` through which it may be accessed and + * manipulated, or `jQuery.fn.dataTable.settings`. + * @member + * @type array + * @default [] + * @private + */ + DataTable.settings = []; + + /** + * Object models container, for the various models that DataTables has + * available to it. These models define the objects that are used to hold + * the active state and configuration of the table. + * @namespace + */ + DataTable.models = {}; + + + + /** + * Template object for the way in which DataTables holds information about + * search information for the global filter and individual column filters. + * @namespace + */ + DataTable.models.oSearch = { + /** + * Flag to indicate if the filtering should be case insensitive or not + * @type boolean + * @default true + */ + "bCaseInsensitive": true, + + /** + * Applied search term + * @type string + * @default <i>Empty string</i> + */ + "sSearch": "", + + /** + * Flag to indicate if the search term should be interpreted as a + * regular expression (true) or not (false) and therefore and special + * regex characters escaped. + * @type boolean + * @default false + */ + "bRegex": false, + + /** + * Flag to indicate if DataTables is to use its smart filtering or not. + * @type boolean + * @default true + */ + "bSmart": true, + + /** + * Flag to indicate if DataTables should only trigger a search when + * the return key is pressed. + * @type boolean + * @default false + */ + "return": false + }; + + + + + /** + * Template object for the way in which DataTables holds information about + * each individual row. This is the object format used for the settings + * aoData array. + * @namespace + */ + DataTable.models.oRow = { + /** + * TR element for the row + * @type node + * @default null + */ + "nTr": null, + + /** + * Array of TD elements for each row. This is null until the row has been + * created. + * @type array nodes + * @default [] + */ + "anCells": null, + + /** + * Data object from the original data source for the row. This is either + * an array if using the traditional form of DataTables, or an object if + * using mData options. The exact type will depend on the passed in + * data from the data source, or will be an array if using DOM a data + * source. + * @type array|object + * @default [] + */ + "_aData": [], + + /** + * Sorting data cache - this array is ostensibly the same length as the + * number of columns (although each index is generated only as it is + * needed), and holds the data that is used for sorting each column in the + * row. We do this cache generation at the start of the sort in order that + * the formatting of the sort data need be done only once for each cell + * per sort. This array should not be read from or written to by anything + * other than the master sorting methods. + * @type array + * @default null + * @private + */ + "_aSortData": null, + + /** + * Per cell filtering data cache. As per the sort data cache, used to + * increase the performance of the filtering in DataTables + * @type array + * @default null + * @private + */ + "_aFilterData": null, + + /** + * Filtering data cache. This is the same as the cell filtering cache, but + * in this case a string rather than an array. This is easily computed with + * a join on `_aFilterData`, but is provided as a cache so the join isn't + * needed on every search (memory traded for performance) + * @type array + * @default null + * @private + */ + "_sFilterRow": null, + + /** + * Cache of the class name that DataTables has applied to the row, so we + * can quickly look at this variable rather than needing to do a DOM check + * on className for the nTr property. + * @type string + * @default <i>Empty string</i> + * @private + */ + "_sRowStripe": "", + + /** + * Denote if the original data source was from the DOM, or the data source + * object. This is used for invalidating data, so DataTables can + * automatically read data from the original source, unless uninstructed + * otherwise. + * @type string + * @default null + * @private + */ + "src": null, + + /** + * Index in the aoData array. This saves an indexOf lookup when we have the + * object, but want to know the index + * @type integer + * @default -1 + * @private + */ + "idx": -1 + }; + + + /** + * Template object for the column information object in DataTables. This object + * is held in the settings aoColumns array and contains all the information that + * DataTables needs about each individual column. + * + * Note that this object is related to {@link DataTable.defaults.column} + * but this one is the internal data store for DataTables's cache of columns. + * It should NOT be manipulated outside of DataTables. Any configuration should + * be done through the initialisation options. + * @namespace + */ + DataTable.models.oColumn = { + /** + * Column index. This could be worked out on-the-fly with $.inArray, but it + * is faster to just hold it as a variable + * @type integer + * @default null + */ + "idx": null, + + /** + * A list of the columns that sorting should occur on when this column + * is sorted. That this property is an array allows multi-column sorting + * to be defined for a column (for example first name / last name columns + * would benefit from this). The values are integers pointing to the + * columns to be sorted on (typically it will be a single integer pointing + * at itself, but that doesn't need to be the case). + * @type array + */ + "aDataSort": null, + + /** + * Define the sorting directions that are applied to the column, in sequence + * as the column is repeatedly sorted upon - i.e. the first value is used + * as the sorting direction when the column if first sorted (clicked on). + * Sort it again (click again) and it will move on to the next index. + * Repeat until loop. + * @type array + */ + "asSorting": null, + + /** + * Flag to indicate if the column is searchable, and thus should be included + * in the filtering or not. + * @type boolean + */ + "bSearchable": null, + + /** + * Flag to indicate if the column is sortable or not. + * @type boolean + */ + "bSortable": null, + + /** + * Flag to indicate if the column is currently visible in the table or not + * @type boolean + */ + "bVisible": null, + + /** + * Store for manual type assignment using the `column.type` option. This + * is held in store so we can manipulate the column's `sType` property. + * @type string + * @default null + * @private + */ + "_sManualType": null, + + /** + * Flag to indicate if HTML5 data attributes should be used as the data + * source for filtering or sorting. True is either are. + * @type boolean + * @default false + * @private + */ + "_bAttrSrc": false, + + /** + * Developer definable function that is called whenever a cell is created (Ajax source, + * etc) or processed for input (DOM source). This can be used as a compliment to mRender + * allowing you to modify the DOM element (add background colour for example) when the + * element is available. + * @type function + * @param {element} nTd The TD node that has been created + * @param {*} sData The Data for the cell + * @param {array|object} oData The data for the whole row + * @param {int} iRow The row index for the aoData data store + * @default null + */ + "fnCreatedCell": null, + + /** + * Function to get data from a cell in a column. You should <b>never</b> + * access data directly through _aData internally in DataTables - always use + * the method attached to this property. It allows mData to function as + * required. This function is automatically assigned by the column + * initialisation method + * @type function + * @param {array|object} oData The data array/object for the array + * (i.e. aoData[]._aData) + * @param {string} sSpecific The specific data type you want to get - + * 'display', 'type' 'filter' 'sort' + * @returns {*} The data for the cell from the given row's data + * @default null + */ + "fnGetData": null, + + /** + * Function to set data for a cell in the column. You should <b>never</b> + * set the data directly to _aData internally in DataTables - always use + * this method. It allows mData to function as required. This function + * is automatically assigned by the column initialisation method + * @type function + * @param {array|object} oData The data array/object for the array + * (i.e. aoData[]._aData) + * @param {*} sValue Value to set + * @default null + */ + "fnSetData": null, + + /** + * Property to read the value for the cells in the column from the data + * source array / object. If null, then the default content is used, if a + * function is given then the return from the function is used. + * @type function|int|string|null + * @default null + */ + "mData": null, + + /** + * Partner property to mData which is used (only when defined) to get + * the data - i.e. it is basically the same as mData, but without the + * 'set' option, and also the data fed to it is the result from mData. + * This is the rendering method to match the data method of mData. + * @type function|int|string|null + * @default null + */ + "mRender": null, + + /** + * Unique header TH/TD element for this column - this is what the sorting + * listener is attached to (if sorting is enabled.) + * @type node + * @default null + */ + "nTh": null, + + /** + * Unique footer TH/TD element for this column (if there is one). Not used + * in DataTables as such, but can be used for plug-ins to reference the + * footer for each column. + * @type node + * @default null + */ + "nTf": null, + + /** + * The class to apply to all TD elements in the table's TBODY for the column + * @type string + * @default null + */ + "sClass": null, + + /** + * When DataTables calculates the column widths to assign to each column, + * it finds the longest string in each column and then constructs a + * temporary table and reads the widths from that. The problem with this + * is that "mmm" is much wider then "iiii", but the latter is a longer + * string - thus the calculation can go wrong (doing it properly and putting + * it into an DOM object and measuring that is horribly(!) slow). Thus as + * a "work around" we provide this option. It will append its value to the + * text that is found to be the longest string for the column - i.e. padding. + * @type string + */ + "sContentPadding": null, + + /** + * Allows a default value to be given for a column's data, and will be used + * whenever a null data source is encountered (this can be because mData + * is set to null, or because the data source itself is null). + * @type string + * @default null + */ + "sDefaultContent": null, + + /** + * Name for the column, allowing reference to the column by name as well as + * by index (needs a lookup to work by name). + * @type string + */ + "sName": null, + + /** + * Custom sorting data type - defines which of the available plug-ins in + * afnSortData the custom sorting will use - if any is defined. + * @type string + * @default std + */ + "sSortDataType": 'std', + + /** + * Class to be applied to the header element when sorting on this column + * @type string + * @default null + */ + "sSortingClass": null, + + /** + * Class to be applied to the header element when sorting on this column - + * when jQuery UI theming is used. + * @type string + * @default null + */ + "sSortingClassJUI": null, + + /** + * Title of the column - what is seen in the TH element (nTh). + * @type string + */ + "sTitle": null, + + /** + * Column sorting and filtering type + * @type string + * @default null + */ + "sType": null, + + /** + * Width of the column + * @type string + * @default null + */ + "sWidth": null, + + /** + * Width of the column when it was first "encountered" + * @type string + * @default null + */ + "sWidthOrig": null + }; + + + /* + * Developer note: The properties of the object below are given in Hungarian + * notation, that was used as the interface for DataTables prior to v1.10, however + * from v1.10 onwards the primary interface is camel case. In order to avoid + * breaking backwards compatibility utterly with this change, the Hungarian + * version is still, internally the primary interface, but is is not documented + * - hence the @name tags in each doc comment. This allows a Javascript function + * to create a map from Hungarian notation to camel case (going the other direction + * would require each property to be listed, which would add around 3K to the size + * of DataTables, while this method is about a 0.5K hit). + * + * Ultimately this does pave the way for Hungarian notation to be dropped + * completely, but that is a massive amount of work and will break current + * installs (therefore is on-hold until v2). + */ + + /** + * Initialisation options that can be given to DataTables at initialisation + * time. + * @namespace + */ + DataTable.defaults = { + /** + * An array of data to use for the table, passed in at initialisation which + * will be used in preference to any data which is already in the DOM. This is + * particularly useful for constructing tables purely in Javascript, for + * example with a custom Ajax call. + * @type array + * @default null + * + * @dtopt Option + * @name DataTable.defaults.data + * + * @example + * // Using a 2D array data source + * $(document).ready( function () { + * $('#example').dataTable( { + * "data": [ + * ['Trident', 'Internet Explorer 4.0', 'Win 95+', 4, 'X'], + * ['Trident', 'Internet Explorer 5.0', 'Win 95+', 5, 'C'], + * ], + * "columns": [ + * { "title": "Engine" }, + * { "title": "Browser" }, + * { "title": "Platform" }, + * { "title": "Version" }, + * { "title": "Grade" } + * ] + * } ); + * } ); + * + * @example + * // Using an array of objects as a data source (`data`) + * $(document).ready( function () { + * $('#example').dataTable( { + * "data": [ + * { + * "engine": "Trident", + * "browser": "Internet Explorer 4.0", + * "platform": "Win 95+", + * "version": 4, + * "grade": "X" + * }, + * { + * "engine": "Trident", + * "browser": "Internet Explorer 5.0", + * "platform": "Win 95+", + * "version": 5, + * "grade": "C" + * } + * ], + * "columns": [ + * { "title": "Engine", "data": "engine" }, + * { "title": "Browser", "data": "browser" }, + * { "title": "Platform", "data": "platform" }, + * { "title": "Version", "data": "version" }, + * { "title": "Grade", "data": "grade" } + * ] + * } ); + * } ); + */ + "aaData": null, + + + /** + * If ordering is enabled, then DataTables will perform a first pass sort on + * initialisation. You can define which column(s) the sort is performed + * upon, and the sorting direction, with this variable. The `sorting` array + * should contain an array for each column to be sorted initially containing + * the column's index and a direction string ('asc' or 'desc'). + * @type array + * @default [[0,'asc']] + * + * @dtopt Option + * @name DataTable.defaults.order + * + * @example + * // Sort by 3rd column first, and then 4th column + * $(document).ready( function() { + * $('#example').dataTable( { + * "order": [[2,'asc'], [3,'desc']] + * } ); + * } ); + * + * // No initial sorting + * $(document).ready( function() { + * $('#example').dataTable( { + * "order": [] + * } ); + * } ); + */ + "aaSorting": [[0,'asc']], + + + /** + * This parameter is basically identical to the `sorting` parameter, but + * cannot be overridden by user interaction with the table. What this means + * is that you could have a column (visible or hidden) which the sorting + * will always be forced on first - any sorting after that (from the user) + * will then be performed as required. This can be useful for grouping rows + * together. + * @type array + * @default null + * + * @dtopt Option + * @name DataTable.defaults.orderFixed + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "orderFixed": [[0,'asc']] + * } ); + * } ) + */ + "aaSortingFixed": [], + + + /** + * DataTables can be instructed to load data to display in the table from a + * Ajax source. This option defines how that Ajax call is made and where to. + * + * The `ajax` property has three different modes of operation, depending on + * how it is defined. These are: + * + * * `string` - Set the URL from where the data should be loaded from. + * * `object` - Define properties for `jQuery.ajax`. + * * `function` - Custom data get function + * + * `string` + * -------- + * + * As a string, the `ajax` property simply defines the URL from which + * DataTables will load data. + * + * `object` + * -------- + * + * As an object, the parameters in the object are passed to + * [jQuery.ajax](http://api.jquery.com/jQuery.ajax/) allowing fine control + * of the Ajax request. DataTables has a number of default parameters which + * you can override using this option. Please refer to the jQuery + * documentation for a full description of the options available, although + * the following parameters provide additional options in DataTables or + * require special consideration: + * + * * `data` - As with jQuery, `data` can be provided as an object, but it + * can also be used as a function to manipulate the data DataTables sends + * to the server. The function takes a single parameter, an object of + * parameters with the values that DataTables has readied for sending. An + * object may be returned which will be merged into the DataTables + * defaults, or you can add the items to the object that was passed in and + * not return anything from the function. This supersedes `fnServerParams` + * from DataTables 1.9-. + * + * * `dataSrc` - By default DataTables will look for the property `data` (or + * `aaData` for compatibility with DataTables 1.9-) when obtaining data + * from an Ajax source or for server-side processing - this parameter + * allows that property to be changed. You can use Javascript dotted + * object notation to get a data source for multiple levels of nesting, or + * it my be used as a function. As a function it takes a single parameter, + * the JSON returned from the server, which can be manipulated as + * required, with the returned value being that used by DataTables as the + * data source for the table. This supersedes `sAjaxDataProp` from + * DataTables 1.9-. + * + * * `success` - Should not be overridden it is used internally in + * DataTables. To manipulate / transform the data returned by the server + * use `ajax.dataSrc`, or use `ajax` as a function (see below). + * + * `function` + * ---------- + * + * As a function, making the Ajax call is left up to yourself allowing + * complete control of the Ajax request. Indeed, if desired, a method other + * than Ajax could be used to obtain the required data, such as Web storage + * or an AIR database. + * + * The function is given four parameters and no return is required. The + * parameters are: + * + * 1. _object_ - Data to send to the server + * 2. _function_ - Callback function that must be executed when the required + * data has been obtained. That data should be passed into the callback + * as the only parameter + * 3. _object_ - DataTables settings object for the table + * + * Note that this supersedes `fnServerData` from DataTables 1.9-. + * + * @type string|object|function + * @default null + * + * @dtopt Option + * @name DataTable.defaults.ajax + * @since 1.10.0 + * + * @example + * // Get JSON data from a file via Ajax. + * // Note DataTables expects data in the form `{ data: [ ...data... ] }` by default). + * $('#example').dataTable( { + * "ajax": "data.json" + * } ); + * + * @example + * // Get JSON data from a file via Ajax, using `dataSrc` to change + * // `data` to `tableData` (i.e. `{ tableData: [ ...data... ] }`) + * $('#example').dataTable( { + * "ajax": { + * "url": "data.json", + * "dataSrc": "tableData" + * } + * } ); + * + * @example + * // Get JSON data from a file via Ajax, using `dataSrc` to read data + * // from a plain array rather than an array in an object + * $('#example').dataTable( { + * "ajax": { + * "url": "data.json", + * "dataSrc": "" + * } + * } ); + * + * @example + * // Manipulate the data returned from the server - add a link to data + * // (note this can, should, be done using `render` for the column - this + * // is just a simple example of how the data can be manipulated). + * $('#example').dataTable( { + * "ajax": { + * "url": "data.json", + * "dataSrc": function ( json ) { + * for ( var i=0, ien=json.length ; i<ien ; i++ ) { + * json[i][0] = '<a href="/message/'+json[i][0]+'>View message</a>'; + * } + * return json; + * } + * } + * } ); + * + * @example + * // Add data to the request + * $('#example').dataTable( { + * "ajax": { + * "url": "data.json", + * "data": function ( d ) { + * return { + * "extra_search": $('#extra').val() + * }; + * } + * } + * } ); + * + * @example + * // Send request as POST + * $('#example').dataTable( { + * "ajax": { + * "url": "data.json", + * "type": "POST" + * } + * } ); + * + * @example + * // Get the data from localStorage (could interface with a form for + * // adding, editing and removing rows). + * $('#example').dataTable( { + * "ajax": function (data, callback, settings) { + * callback( + * JSON.parse( localStorage.getItem('dataTablesData') ) + * ); + * } + * } ); + */ + "ajax": null, + + + /** + * This parameter allows you to readily specify the entries in the length drop + * down menu that DataTables shows when pagination is enabled. It can be + * either a 1D array of options which will be used for both the displayed + * option and the value, or a 2D array which will use the array in the first + * position as the value, and the array in the second position as the + * displayed options (useful for language strings such as 'All'). + * + * Note that the `pageLength` property will be automatically set to the + * first value given in this array, unless `pageLength` is also provided. + * @type array + * @default [ 10, 25, 50, 100 ] + * + * @dtopt Option + * @name DataTable.defaults.lengthMenu + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "lengthMenu": [[10, 25, 50, -1], [10, 25, 50, "All"]] + * } ); + * } ); + */ + "aLengthMenu": [ 10, 25, 50, 100 ], + + + /** + * The `columns` option in the initialisation parameter allows you to define + * details about the way individual columns behave. For a full list of + * column options that can be set, please see + * {@link DataTable.defaults.column}. Note that if you use `columns` to + * define your columns, you must have an entry in the array for every single + * column that you have in your table (these can be null if you don't which + * to specify any options). + * @member + * + * @name DataTable.defaults.column + */ + "aoColumns": null, + + /** + * Very similar to `columns`, `columnDefs` allows you to target a specific + * column, multiple columns, or all columns, using the `targets` property of + * each object in the array. This allows great flexibility when creating + * tables, as the `columnDefs` arrays can be of any length, targeting the + * columns you specifically want. `columnDefs` may use any of the column + * options available: {@link DataTable.defaults.column}, but it _must_ + * have `targets` defined in each object in the array. Values in the `targets` + * array may be: + * <ul> + * <li>a string - class name will be matched on the TH for the column</li> + * <li>0 or a positive integer - column index counting from the left</li> + * <li>a negative integer - column index counting from the right</li> + * <li>the string "_all" - all columns (i.e. assign a default)</li> + * </ul> + * @member + * + * @name DataTable.defaults.columnDefs + */ + "aoColumnDefs": null, + + + /** + * Basically the same as `search`, this parameter defines the individual column + * filtering state at initialisation time. The array must be of the same size + * as the number of columns, and each element be an object with the parameters + * `search` and `escapeRegex` (the latter is optional). 'null' is also + * accepted and the default will be used. + * @type array + * @default [] + * + * @dtopt Option + * @name DataTable.defaults.searchCols + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "searchCols": [ + * null, + * { "search": "My filter" }, + * null, + * { "search": "^[0-9]", "escapeRegex": false } + * ] + * } ); + * } ) + */ + "aoSearchCols": [], + + + /** + * An array of CSS classes that should be applied to displayed rows. This + * array may be of any length, and DataTables will apply each class + * sequentially, looping when required. + * @type array + * @default null <i>Will take the values determined by the `oClasses.stripe*` + * options</i> + * + * @dtopt Option + * @name DataTable.defaults.stripeClasses + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "stripeClasses": [ 'strip1', 'strip2', 'strip3' ] + * } ); + * } ) + */ + "asStripeClasses": null, + + + /** + * Enable or disable automatic column width calculation. This can be disabled + * as an optimisation (it takes some time to calculate the widths) if the + * tables widths are passed in using `columns`. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.autoWidth + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "autoWidth": false + * } ); + * } ); + */ + "bAutoWidth": true, + + + /** + * Deferred rendering can provide DataTables with a huge speed boost when you + * are using an Ajax or JS data source for the table. This option, when set to + * true, will cause DataTables to defer the creation of the table elements for + * each row until they are needed for a draw - saving a significant amount of + * time. + * @type boolean + * @default false + * + * @dtopt Features + * @name DataTable.defaults.deferRender + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "ajax": "sources/arrays.txt", + * "deferRender": true + * } ); + * } ); + */ + "bDeferRender": false, + + + /** + * Replace a DataTable which matches the given selector and replace it with + * one which has the properties of the new initialisation object passed. If no + * table matches the selector, then the new DataTable will be constructed as + * per normal. + * @type boolean + * @default false + * + * @dtopt Options + * @name DataTable.defaults.destroy + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "srollY": "200px", + * "paginate": false + * } ); + * + * // Some time later.... + * $('#example').dataTable( { + * "filter": false, + * "destroy": true + * } ); + * } ); + */ + "bDestroy": false, + + + /** + * Enable or disable filtering of data. Filtering in DataTables is "smart" in + * that it allows the end user to input multiple words (space separated) and + * will match a row containing those words, even if not in the order that was + * specified (this allow matching across multiple columns). Note that if you + * wish to use filtering in DataTables this must remain 'true' - to remove the + * default filtering input box and retain filtering abilities, please use + * {@link DataTable.defaults.dom}. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.searching + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "searching": false + * } ); + * } ); + */ + "bFilter": true, + + + /** + * Enable or disable the table information display. This shows information + * about the data that is currently visible on the page, including information + * about filtered data if that action is being performed. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.info + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "info": false + * } ); + * } ); + */ + "bInfo": true, + + + /** + * Allows the end user to select the size of a formatted page from a select + * menu (sizes are 10, 25, 50 and 100). Requires pagination (`paginate`). + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.lengthChange + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "lengthChange": false + * } ); + * } ); + */ + "bLengthChange": true, + + + /** + * Enable or disable pagination. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.paging + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "paging": false + * } ); + * } ); + */ + "bPaginate": true, + + + /** + * Enable or disable the display of a 'processing' indicator when the table is + * being processed (e.g. a sort). This is particularly useful for tables with + * large amounts of data where it can take a noticeable amount of time to sort + * the entries. + * @type boolean + * @default false + * + * @dtopt Features + * @name DataTable.defaults.processing + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "processing": true + * } ); + * } ); + */ + "bProcessing": false, + + + /** + * Retrieve the DataTables object for the given selector. Note that if the + * table has already been initialised, this parameter will cause DataTables + * to simply return the object that has already been set up - it will not take + * account of any changes you might have made to the initialisation object + * passed to DataTables (setting this parameter to true is an acknowledgement + * that you understand this). `destroy` can be used to reinitialise a table if + * you need. + * @type boolean + * @default false + * + * @dtopt Options + * @name DataTable.defaults.retrieve + * + * @example + * $(document).ready( function() { + * initTable(); + * tableActions(); + * } ); + * + * function initTable () + * { + * return $('#example').dataTable( { + * "scrollY": "200px", + * "paginate": false, + * "retrieve": true + * } ); + * } + * + * function tableActions () + * { + * var table = initTable(); + * // perform API operations with oTable + * } + */ + "bRetrieve": false, + + + /** + * When vertical (y) scrolling is enabled, DataTables will force the height of + * the table's viewport to the given height at all times (useful for layout). + * However, this can look odd when filtering data down to a small data set, + * and the footer is left "floating" further down. This parameter (when + * enabled) will cause DataTables to collapse the table's viewport down when + * the result set will fit within the given Y height. + * @type boolean + * @default false + * + * @dtopt Options + * @name DataTable.defaults.scrollCollapse + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "scrollY": "200", + * "scrollCollapse": true + * } ); + * } ); + */ + "bScrollCollapse": false, + + + /** + * Configure DataTables to use server-side processing. Note that the + * `ajax` parameter must also be given in order to give DataTables a + * source to obtain the required data for each draw. + * @type boolean + * @default false + * + * @dtopt Features + * @dtopt Server-side + * @name DataTable.defaults.serverSide + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "serverSide": true, + * "ajax": "xhr.php" + * } ); + * } ); + */ + "bServerSide": false, + + + /** + * Enable or disable sorting of columns. Sorting of individual columns can be + * disabled by the `sortable` option for each column. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.ordering + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "ordering": false + * } ); + * } ); + */ + "bSort": true, + + + /** + * Enable or display DataTables' ability to sort multiple columns at the + * same time (activated by shift-click by the user). + * @type boolean + * @default true + * + * @dtopt Options + * @name DataTable.defaults.orderMulti + * + * @example + * // Disable multiple column sorting ability + * $(document).ready( function () { + * $('#example').dataTable( { + * "orderMulti": false + * } ); + * } ); + */ + "bSortMulti": true, + + + /** + * Allows control over whether DataTables should use the top (true) unique + * cell that is found for a single column, or the bottom (false - default). + * This is useful when using complex headers. + * @type boolean + * @default false + * + * @dtopt Options + * @name DataTable.defaults.orderCellsTop + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "orderCellsTop": true + * } ); + * } ); + */ + "bSortCellsTop": false, + + + /** + * Enable or disable the addition of the classes `sorting\_1`, `sorting\_2` and + * `sorting\_3` to the columns which are currently being sorted on. This is + * presented as a feature switch as it can increase processing time (while + * classes are removed and added) so for large data sets you might want to + * turn this off. + * @type boolean + * @default true + * + * @dtopt Features + * @name DataTable.defaults.orderClasses + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "orderClasses": false + * } ); + * } ); + */ + "bSortClasses": true, + + + /** + * Enable or disable state saving. When enabled HTML5 `localStorage` will be + * used to save table display information such as pagination information, + * display length, filtering and sorting. As such when the end user reloads + * the page the display display will match what thy had previously set up. + * + * Due to the use of `localStorage` the default state saving is not supported + * in IE6 or 7. If state saving is required in those browsers, use + * `stateSaveCallback` to provide a storage solution such as cookies. + * @type boolean + * @default false + * + * @dtopt Features + * @name DataTable.defaults.stateSave + * + * @example + * $(document).ready( function () { + * $('#example').dataTable( { + * "stateSave": true + * } ); + * } ); + */ + "bStateSave": false, + + + /** + * This function is called when a TR element is created (and all TD child + * elements have been inserted), or registered if using a DOM source, allowing + * manipulation of the TR element (adding classes etc). + * @type function + * @param {node} row "TR" element for the current row + * @param {array} data Raw data array for this row + * @param {int} dataIndex The index of this row in the internal aoData array + * + * @dtopt Callbacks + * @name DataTable.defaults.createdRow + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "createdRow": function( row, data, dataIndex ) { + * // Bold the grade for all 'A' grade browsers + * if ( data[4] == "A" ) + * { + * $('td:eq(4)', row).html( '<b>A</b>' ); + * } + * } + * } ); + * } ); + */ + "fnCreatedRow": null, + + + /** + * This function is called on every 'draw' event, and allows you to + * dynamically modify any aspect you want about the created DOM. + * @type function + * @param {object} settings DataTables settings object + * + * @dtopt Callbacks + * @name DataTable.defaults.drawCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "drawCallback": function( settings ) { + * alert( 'DataTables has redrawn the table' ); + * } + * } ); + * } ); + */ + "fnDrawCallback": null, + + + /** + * Identical to fnHeaderCallback() but for the table footer this function + * allows you to modify the table footer on every 'draw' event. + * @type function + * @param {node} foot "TR" element for the footer + * @param {array} data Full table data (as derived from the original HTML) + * @param {int} start Index for the current display starting point in the + * display array + * @param {int} end Index for the current display ending point in the + * display array + * @param {array int} display Index array to translate the visual position + * to the full data array + * + * @dtopt Callbacks + * @name DataTable.defaults.footerCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "footerCallback": function( tfoot, data, start, end, display ) { + * tfoot.getElementsByTagName('th')[0].innerHTML = "Starting index is "+start; + * } + * } ); + * } ) + */ + "fnFooterCallback": null, + + + /** + * When rendering large numbers in the information element for the table + * (i.e. "Showing 1 to 10 of 57 entries") DataTables will render large numbers + * to have a comma separator for the 'thousands' units (e.g. 1 million is + * rendered as "1,000,000") to help readability for the end user. This + * function will override the default method DataTables uses. + * @type function + * @member + * @param {int} toFormat number to be formatted + * @returns {string} formatted string for DataTables to show the number + * + * @dtopt Callbacks + * @name DataTable.defaults.formatNumber + * + * @example + * // Format a number using a single quote for the separator (note that + * // this can also be done with the language.thousands option) + * $(document).ready( function() { + * $('#example').dataTable( { + * "formatNumber": function ( toFormat ) { + * return toFormat.toString().replace( + * /\B(?=(\d{3})+(?!\d))/g, "'" + * ); + * }; + * } ); + * } ); + */ + "fnFormatNumber": function ( toFormat ) { + return toFormat.toString().replace( + /\B(?=(\d{3})+(?!\d))/g, + this.oLanguage.sThousands + ); + }, + + + /** + * This function is called on every 'draw' event, and allows you to + * dynamically modify the header row. This can be used to calculate and + * display useful information about the table. + * @type function + * @param {node} head "TR" element for the header + * @param {array} data Full table data (as derived from the original HTML) + * @param {int} start Index for the current display starting point in the + * display array + * @param {int} end Index for the current display ending point in the + * display array + * @param {array int} display Index array to translate the visual position + * to the full data array + * + * @dtopt Callbacks + * @name DataTable.defaults.headerCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "fheaderCallback": function( head, data, start, end, display ) { + * head.getElementsByTagName('th')[0].innerHTML = "Displaying "+(end-start)+" records"; + * } + * } ); + * } ) + */ + "fnHeaderCallback": null, + + + /** + * The information element can be used to convey information about the current + * state of the table. Although the internationalisation options presented by + * DataTables are quite capable of dealing with most customisations, there may + * be times where you wish to customise the string further. This callback + * allows you to do exactly that. + * @type function + * @param {object} oSettings DataTables settings object + * @param {int} start Starting position in data for the draw + * @param {int} end End position in data for the draw + * @param {int} max Total number of rows in the table (regardless of + * filtering) + * @param {int} total Total number of rows in the data set, after filtering + * @param {string} pre The string that DataTables has formatted using it's + * own rules + * @returns {string} The string to be displayed in the information element. + * + * @dtopt Callbacks + * @name DataTable.defaults.infoCallback + * + * @example + * $('#example').dataTable( { + * "infoCallback": function( settings, start, end, max, total, pre ) { + * return start +" to "+ end; + * } + * } ); + */ + "fnInfoCallback": null, + + + /** + * Called when the table has been initialised. Normally DataTables will + * initialise sequentially and there will be no need for this function, + * however, this does not hold true when using external language information + * since that is obtained using an async XHR call. + * @type function + * @param {object} settings DataTables settings object + * @param {object} json The JSON object request from the server - only + * present if client-side Ajax sourced data is used + * + * @dtopt Callbacks + * @name DataTable.defaults.initComplete + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "initComplete": function(settings, json) { + * alert( 'DataTables has finished its initialisation.' ); + * } + * } ); + * } ) + */ + "fnInitComplete": null, + + + /** + * Called at the very start of each table draw and can be used to cancel the + * draw by returning false, any other return (including undefined) results in + * the full draw occurring). + * @type function + * @param {object} settings DataTables settings object + * @returns {boolean} False will cancel the draw, anything else (including no + * return) will allow it to complete. + * + * @dtopt Callbacks + * @name DataTable.defaults.preDrawCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "preDrawCallback": function( settings ) { + * if ( $('#test').val() == 1 ) { + * return false; + * } + * } + * } ); + * } ); + */ + "fnPreDrawCallback": null, + + + /** + * This function allows you to 'post process' each row after it have been + * generated for each table draw, but before it is rendered on screen. This + * function might be used for setting the row class name etc. + * @type function + * @param {node} row "TR" element for the current row + * @param {array} data Raw data array for this row + * @param {int} displayIndex The display index for the current table draw + * @param {int} displayIndexFull The index of the data in the full list of + * rows (after filtering) + * + * @dtopt Callbacks + * @name DataTable.defaults.rowCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "rowCallback": function( row, data, displayIndex, displayIndexFull ) { + * // Bold the grade for all 'A' grade browsers + * if ( data[4] == "A" ) { + * $('td:eq(4)', row).html( '<b>A</b>' ); + * } + * } + * } ); + * } ); + */ + "fnRowCallback": null, + + + /** + * __Deprecated__ The functionality provided by this parameter has now been + * superseded by that provided through `ajax`, which should be used instead. + * + * This parameter allows you to override the default function which obtains + * the data from the server so something more suitable for your application. + * For example you could use POST data, or pull information from a Gears or + * AIR database. + * @type function + * @member + * @param {string} source HTTP source to obtain the data from (`ajax`) + * @param {array} data A key/value pair object containing the data to send + * to the server + * @param {function} callback to be called on completion of the data get + * process that will draw the data on the page. + * @param {object} settings DataTables settings object + * + * @dtopt Callbacks + * @dtopt Server-side + * @name DataTable.defaults.serverData + * + * @deprecated 1.10. Please use `ajax` for this functionality now. + */ + "fnServerData": null, + + + /** + * __Deprecated__ The functionality provided by this parameter has now been + * superseded by that provided through `ajax`, which should be used instead. + * + * It is often useful to send extra data to the server when making an Ajax + * request - for example custom filtering information, and this callback + * function makes it trivial to send extra information to the server. The + * passed in parameter is the data set that has been constructed by + * DataTables, and you can add to this or modify it as you require. + * @type function + * @param {array} data Data array (array of objects which are name/value + * pairs) that has been constructed by DataTables and will be sent to the + * server. In the case of Ajax sourced data with server-side processing + * this will be an empty array, for server-side processing there will be a + * significant number of parameters! + * @returns {undefined} Ensure that you modify the data array passed in, + * as this is passed by reference. + * + * @dtopt Callbacks + * @dtopt Server-side + * @name DataTable.defaults.serverParams + * + * @deprecated 1.10. Please use `ajax` for this functionality now. + */ + "fnServerParams": null, + + + /** + * Load the table state. With this function you can define from where, and how, the + * state of a table is loaded. By default DataTables will load from `localStorage` + * but you might wish to use a server-side database or cookies. + * @type function + * @member + * @param {object} settings DataTables settings object + * @param {object} callback Callback that can be executed when done. It + * should be passed the loaded state object. + * @return {object} The DataTables state object to be loaded + * + * @dtopt Callbacks + * @name DataTable.defaults.stateLoadCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateLoadCallback": function (settings, callback) { + * $.ajax( { + * "url": "/state_load", + * "dataType": "json", + * "success": function (json) { + * callback( json ); + * } + * } ); + * } + * } ); + * } ); + */ + "fnStateLoadCallback": function ( settings ) { + try { + return JSON.parse( + (settings.iStateDuration === -1 ? sessionStorage : localStorage).getItem( + 'DataTables_'+settings.sInstance+'_'+location.pathname + ) + ); + } catch (e) { + return {}; + } + }, + + + /** + * Callback which allows modification of the saved state prior to loading that state. + * This callback is called when the table is loading state from the stored data, but + * prior to the settings object being modified by the saved state. Note that for + * plug-in authors, you should use the `stateLoadParams` event to load parameters for + * a plug-in. + * @type function + * @param {object} settings DataTables settings object + * @param {object} data The state object that is to be loaded + * + * @dtopt Callbacks + * @name DataTable.defaults.stateLoadParams + * + * @example + * // Remove a saved filter, so filtering is never loaded + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateLoadParams": function (settings, data) { + * data.oSearch.sSearch = ""; + * } + * } ); + * } ); + * + * @example + * // Disallow state loading by returning false + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateLoadParams": function (settings, data) { + * return false; + * } + * } ); + * } ); + */ + "fnStateLoadParams": null, + + + /** + * Callback that is called when the state has been loaded from the state saving method + * and the DataTables settings object has been modified as a result of the loaded state. + * @type function + * @param {object} settings DataTables settings object + * @param {object} data The state object that was loaded + * + * @dtopt Callbacks + * @name DataTable.defaults.stateLoaded + * + * @example + * // Show an alert with the filtering value that was saved + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateLoaded": function (settings, data) { + * alert( 'Saved filter was: '+data.oSearch.sSearch ); + * } + * } ); + * } ); + */ + "fnStateLoaded": null, + + + /** + * Save the table state. This function allows you to define where and how the state + * information for the table is stored By default DataTables will use `localStorage` + * but you might wish to use a server-side database or cookies. + * @type function + * @member + * @param {object} settings DataTables settings object + * @param {object} data The state object to be saved + * + * @dtopt Callbacks + * @name DataTable.defaults.stateSaveCallback + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateSaveCallback": function (settings, data) { + * // Send an Ajax request to the server with the state object + * $.ajax( { + * "url": "/state_save", + * "data": data, + * "dataType": "json", + * "method": "POST" + * "success": function () {} + * } ); + * } + * } ); + * } ); + */ + "fnStateSaveCallback": function ( settings, data ) { + try { + (settings.iStateDuration === -1 ? sessionStorage : localStorage).setItem( + 'DataTables_'+settings.sInstance+'_'+location.pathname, + JSON.stringify( data ) + ); + } catch (e) {} + }, + + + /** + * Callback which allows modification of the state to be saved. Called when the table + * has changed state a new state save is required. This method allows modification of + * the state saving object prior to actually doing the save, including addition or + * other state properties or modification. Note that for plug-in authors, you should + * use the `stateSaveParams` event to save parameters for a plug-in. + * @type function + * @param {object} settings DataTables settings object + * @param {object} data The state object to be saved + * + * @dtopt Callbacks + * @name DataTable.defaults.stateSaveParams + * + * @example + * // Remove a saved filter, so filtering is never saved + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateSave": true, + * "stateSaveParams": function (settings, data) { + * data.oSearch.sSearch = ""; + * } + * } ); + * } ); + */ + "fnStateSaveParams": null, + + + /** + * Duration for which the saved state information is considered valid. After this period + * has elapsed the state will be returned to the default. + * Value is given in seconds. + * @type int + * @default 7200 <i>(2 hours)</i> + * + * @dtopt Options + * @name DataTable.defaults.stateDuration + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "stateDuration": 60*60*24; // 1 day + * } ); + * } ) + */ + "iStateDuration": 7200, + + + /** + * When enabled DataTables will not make a request to the server for the first + * page draw - rather it will use the data already on the page (no sorting etc + * will be applied to it), thus saving on an XHR at load time. `deferLoading` + * is used to indicate that deferred loading is required, but it is also used + * to tell DataTables how many records there are in the full table (allowing + * the information element and pagination to be displayed correctly). In the case + * where a filtering is applied to the table on initial load, this can be + * indicated by giving the parameter as an array, where the first element is + * the number of records available after filtering and the second element is the + * number of records without filtering (allowing the table information element + * to be shown correctly). + * @type int | array + * @default null + * + * @dtopt Options + * @name DataTable.defaults.deferLoading + * + * @example + * // 57 records available in the table, no filtering applied + * $(document).ready( function() { + * $('#example').dataTable( { + * "serverSide": true, + * "ajax": "scripts/server_processing.php", + * "deferLoading": 57 + * } ); + * } ); + * + * @example + * // 57 records after filtering, 100 without filtering (an initial filter applied) + * $(document).ready( function() { + * $('#example').dataTable( { + * "serverSide": true, + * "ajax": "scripts/server_processing.php", + * "deferLoading": [ 57, 100 ], + * "search": { + * "search": "my_filter" + * } + * } ); + * } ); + */ + "iDeferLoading": null, + + + /** + * Number of rows to display on a single page when using pagination. If + * feature enabled (`lengthChange`) then the end user will be able to override + * this to a custom setting using a pop-up menu. + * @type int + * @default 10 + * + * @dtopt Options + * @name DataTable.defaults.pageLength + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "pageLength": 50 + * } ); + * } ) + */ + "iDisplayLength": 10, + + + /** + * Define the starting point for data display when using DataTables with + * pagination. Note that this parameter is the number of records, rather than + * the page number, so if you have 10 records per page and want to start on + * the third page, it should be "20". + * @type int + * @default 0 + * + * @dtopt Options + * @name DataTable.defaults.displayStart + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "displayStart": 20 + * } ); + * } ) + */ + "iDisplayStart": 0, + + + /** + * By default DataTables allows keyboard navigation of the table (sorting, paging, + * and filtering) by adding a `tabindex` attribute to the required elements. This + * allows you to tab through the controls and press the enter key to activate them. + * The tabindex is default 0, meaning that the tab follows the flow of the document. + * You can overrule this using this parameter if you wish. Use a value of -1 to + * disable built-in keyboard navigation. + * @type int + * @default 0 + * + * @dtopt Options + * @name DataTable.defaults.tabIndex + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "tabIndex": 1 + * } ); + * } ); + */ + "iTabIndex": 0, + + + /** + * Classes that DataTables assigns to the various components and features + * that it adds to the HTML table. This allows classes to be configured + * during initialisation in addition to through the static + * {@link DataTable.ext.oStdClasses} object). + * @namespace + * @name DataTable.defaults.classes + */ + "oClasses": {}, + + + /** + * All strings that DataTables uses in the user interface that it creates + * are defined in this object, allowing you to modified them individually or + * completely replace them all as required. + * @namespace + * @name DataTable.defaults.language + */ + "oLanguage": { + /** + * Strings that are used for WAI-ARIA labels and controls only (these are not + * actually visible on the page, but will be read by screenreaders, and thus + * must be internationalised as well). + * @namespace + * @name DataTable.defaults.language.aria + */ + "oAria": { + /** + * ARIA label that is added to the table headers when the column may be + * sorted ascending by activing the column (click or return when focused). + * Note that the column header is prefixed to this string. + * @type string + * @default : activate to sort column ascending + * + * @dtopt Language + * @name DataTable.defaults.language.aria.sortAscending + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "aria": { + * "sortAscending": " - click/return to sort ascending" + * } + * } + * } ); + * } ); + */ + "sSortAscending": ": activate to sort column ascending", + + /** + * ARIA label that is added to the table headers when the column may be + * sorted descending by activing the column (click or return when focused). + * Note that the column header is prefixed to this string. + * @type string + * @default : activate to sort column ascending + * + * @dtopt Language + * @name DataTable.defaults.language.aria.sortDescending + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "aria": { + * "sortDescending": " - click/return to sort descending" + * } + * } + * } ); + * } ); + */ + "sSortDescending": ": activate to sort column descending" + }, + + /** + * Pagination string used by DataTables for the built-in pagination + * control types. + * @namespace + * @name DataTable.defaults.language.paginate + */ + "oPaginate": { + /** + * Text to use when using the 'full_numbers' type of pagination for the + * button to take the user to the first page. + * @type string + * @default First + * + * @dtopt Language + * @name DataTable.defaults.language.paginate.first + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "paginate": { + * "first": "First page" + * } + * } + * } ); + * } ); + */ + "sFirst": "First", + + + /** + * Text to use when using the 'full_numbers' type of pagination for the + * button to take the user to the last page. + * @type string + * @default Last + * + * @dtopt Language + * @name DataTable.defaults.language.paginate.last + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "paginate": { + * "last": "Last page" + * } + * } + * } ); + * } ); + */ + "sLast": "Last", + + + /** + * Text to use for the 'next' pagination button (to take the user to the + * next page). + * @type string + * @default Next + * + * @dtopt Language + * @name DataTable.defaults.language.paginate.next + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "paginate": { + * "next": "Next page" + * } + * } + * } ); + * } ); + */ + "sNext": "Next", + + + /** + * Text to use for the 'previous' pagination button (to take the user to + * the previous page). + * @type string + * @default Previous + * + * @dtopt Language + * @name DataTable.defaults.language.paginate.previous + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "paginate": { + * "previous": "Previous page" + * } + * } + * } ); + * } ); + */ + "sPrevious": "Previous" + }, + + /** + * This string is shown in preference to `zeroRecords` when the table is + * empty of data (regardless of filtering). Note that this is an optional + * parameter - if it is not given, the value of `zeroRecords` will be used + * instead (either the default or given value). + * @type string + * @default No data available in table + * + * @dtopt Language + * @name DataTable.defaults.language.emptyTable + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "emptyTable": "No data available in table" + * } + * } ); + * } ); + */ + "sEmptyTable": "No data available in table", + + + /** + * This string gives information to the end user about the information + * that is current on display on the page. The following tokens can be + * used in the string and will be dynamically replaced as the table + * display updates. This tokens can be placed anywhere in the string, or + * removed as needed by the language requires: + * + * * `\_START\_` - Display index of the first record on the current page + * * `\_END\_` - Display index of the last record on the current page + * * `\_TOTAL\_` - Number of records in the table after filtering + * * `\_MAX\_` - Number of records in the table without filtering + * * `\_PAGE\_` - Current page number + * * `\_PAGES\_` - Total number of pages of data in the table + * + * @type string + * @default Showing _START_ to _END_ of _TOTAL_ entries + * + * @dtopt Language + * @name DataTable.defaults.language.info + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "info": "Showing page _PAGE_ of _PAGES_" + * } + * } ); + * } ); + */ + "sInfo": "Showing _START_ to _END_ of _TOTAL_ entries", + + + /** + * Display information string for when the table is empty. Typically the + * format of this string should match `info`. + * @type string + * @default Showing 0 to 0 of 0 entries + * + * @dtopt Language + * @name DataTable.defaults.language.infoEmpty + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "infoEmpty": "No entries to show" + * } + * } ); + * } ); + */ + "sInfoEmpty": "Showing 0 to 0 of 0 entries", + + + /** + * When a user filters the information in a table, this string is appended + * to the information (`info`) to give an idea of how strong the filtering + * is. The variable _MAX_ is dynamically updated. + * @type string + * @default (filtered from _MAX_ total entries) + * + * @dtopt Language + * @name DataTable.defaults.language.infoFiltered + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "infoFiltered": " - filtering from _MAX_ records" + * } + * } ); + * } ); + */ + "sInfoFiltered": "(filtered from _MAX_ total entries)", + + + /** + * If can be useful to append extra information to the info string at times, + * and this variable does exactly that. This information will be appended to + * the `info` (`infoEmpty` and `infoFiltered` in whatever combination they are + * being used) at all times. + * @type string + * @default <i>Empty string</i> + * + * @dtopt Language + * @name DataTable.defaults.language.infoPostFix + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "infoPostFix": "All records shown are derived from real information." + * } + * } ); + * } ); + */ + "sInfoPostFix": "", + + + /** + * This decimal place operator is a little different from the other + * language options since DataTables doesn't output floating point + * numbers, so it won't ever use this for display of a number. Rather, + * what this parameter does is modify the sort methods of the table so + * that numbers which are in a format which has a character other than + * a period (`.`) as a decimal place will be sorted numerically. + * + * Note that numbers with different decimal places cannot be shown in + * the same table and still be sortable, the table must be consistent. + * However, multiple different tables on the page can use different + * decimal place characters. + * @type string + * @default + * + * @dtopt Language + * @name DataTable.defaults.language.decimal + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "decimal": "," + * "thousands": "." + * } + * } ); + * } ); + */ + "sDecimal": "", + + + /** + * DataTables has a build in number formatter (`formatNumber`) which is + * used to format large numbers that are used in the table information. + * By default a comma is used, but this can be trivially changed to any + * character you wish with this parameter. + * @type string + * @default , + * + * @dtopt Language + * @name DataTable.defaults.language.thousands + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "thousands": "'" + * } + * } ); + * } ); + */ + "sThousands": ",", + + + /** + * Detail the action that will be taken when the drop down menu for the + * pagination length option is changed. The '_MENU_' variable is replaced + * with a default select list of 10, 25, 50 and 100, and can be replaced + * with a custom select box if required. + * @type string + * @default Show _MENU_ entries + * + * @dtopt Language + * @name DataTable.defaults.language.lengthMenu + * + * @example + * // Language change only + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "lengthMenu": "Display _MENU_ records" + * } + * } ); + * } ); + * + * @example + * // Language and options change + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "lengthMenu": 'Display <select>'+ + * '<option value="10">10</option>'+ + * '<option value="20">20</option>'+ + * '<option value="30">30</option>'+ + * '<option value="40">40</option>'+ + * '<option value="50">50</option>'+ + * '<option value="-1">All</option>'+ + * '</select> records' + * } + * } ); + * } ); + */ + "sLengthMenu": "Show _MENU_ entries", + + + /** + * When using Ajax sourced data and during the first draw when DataTables is + * gathering the data, this message is shown in an empty row in the table to + * indicate to the end user the the data is being loaded. Note that this + * parameter is not used when loading data by server-side processing, just + * Ajax sourced data with client-side processing. + * @type string + * @default Loading... + * + * @dtopt Language + * @name DataTable.defaults.language.loadingRecords + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "loadingRecords": "Please wait - loading..." + * } + * } ); + * } ); + */ + "sLoadingRecords": "Loading...", + + + /** + * Text which is displayed when the table is processing a user action + * (usually a sort command or similar). + * @type string + * @default Processing... + * + * @dtopt Language + * @name DataTable.defaults.language.processing + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "processing": "DataTables is currently busy" + * } + * } ); + * } ); + */ + "sProcessing": "Processing...", + + + /** + * Details the actions that will be taken when the user types into the + * filtering input text box. The variable "_INPUT_", if used in the string, + * is replaced with the HTML text box for the filtering input allowing + * control over where it appears in the string. If "_INPUT_" is not given + * then the input box is appended to the string automatically. + * @type string + * @default Search: + * + * @dtopt Language + * @name DataTable.defaults.language.search + * + * @example + * // Input text box will be appended at the end automatically + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "search": "Filter records:" + * } + * } ); + * } ); + * + * @example + * // Specify where the filter should appear + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "search": "Apply filter _INPUT_ to table" + * } + * } ); + * } ); + */ + "sSearch": "Search:", + + + /** + * Assign a `placeholder` attribute to the search `input` element + * @type string + * @default + * + * @dtopt Language + * @name DataTable.defaults.language.searchPlaceholder + */ + "sSearchPlaceholder": "", + + + /** + * All of the language information can be stored in a file on the + * server-side, which DataTables will look up if this parameter is passed. + * It must store the URL of the language file, which is in a JSON format, + * and the object has the same properties as the oLanguage object in the + * initialiser object (i.e. the above parameters). Please refer to one of + * the example language files to see how this works in action. + * @type string + * @default <i>Empty string - i.e. disabled</i> + * + * @dtopt Language + * @name DataTable.defaults.language.url + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "url": "http://www.sprymedia.co.uk/dataTables/lang.txt" + * } + * } ); + * } ); + */ + "sUrl": "", + + + /** + * Text shown inside the table records when the is no information to be + * displayed after filtering. `emptyTable` is shown when there is simply no + * information in the table at all (regardless of filtering). + * @type string + * @default No matching records found + * + * @dtopt Language + * @name DataTable.defaults.language.zeroRecords + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "language": { + * "zeroRecords": "No records to display" + * } + * } ); + * } ); + */ + "sZeroRecords": "No matching records found" + }, + + + /** + * This parameter allows you to have define the global filtering state at + * initialisation time. As an object the `search` parameter must be + * defined, but all other parameters are optional. When `regex` is true, + * the search string will be treated as a regular expression, when false + * (default) it will be treated as a straight string. When `smart` + * DataTables will use it's smart filtering methods (to word match at + * any point in the data), when false this will not be done. + * @namespace + * @extends DataTable.models.oSearch + * + * @dtopt Options + * @name DataTable.defaults.search + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "search": {"search": "Initial search"} + * } ); + * } ) + */ + "oSearch": $.extend( {}, DataTable.models.oSearch ), + + + /** + * __Deprecated__ The functionality provided by this parameter has now been + * superseded by that provided through `ajax`, which should be used instead. + * + * By default DataTables will look for the property `data` (or `aaData` for + * compatibility with DataTables 1.9-) when obtaining data from an Ajax + * source or for server-side processing - this parameter allows that + * property to be changed. You can use Javascript dotted object notation to + * get a data source for multiple levels of nesting. + * @type string + * @default data + * + * @dtopt Options + * @dtopt Server-side + * @name DataTable.defaults.ajaxDataProp + * + * @deprecated 1.10. Please use `ajax` for this functionality now. + */ + "sAjaxDataProp": "data", + + + /** + * __Deprecated__ The functionality provided by this parameter has now been + * superseded by that provided through `ajax`, which should be used instead. + * + * You can instruct DataTables to load data from an external + * source using this parameter (use aData if you want to pass data in you + * already have). Simply provide a url a JSON object can be obtained from. + * @type string + * @default null + * + * @dtopt Options + * @dtopt Server-side + * @name DataTable.defaults.ajaxSource + * + * @deprecated 1.10. Please use `ajax` for this functionality now. + */ + "sAjaxSource": null, + + + /** + * This initialisation variable allows you to specify exactly where in the + * DOM you want DataTables to inject the various controls it adds to the page + * (for example you might want the pagination controls at the top of the + * table). DIV elements (with or without a custom class) can also be added to + * aid styling. The follow syntax is used: + * <ul> + * <li>The following options are allowed: + * <ul> + * <li>'l' - Length changing</li> + * <li>'f' - Filtering input</li> + * <li>'t' - The table!</li> + * <li>'i' - Information</li> + * <li>'p' - Pagination</li> + * <li>'r' - pRocessing</li> + * </ul> + * </li> + * <li>The following constants are allowed: + * <ul> + * <li>'H' - jQueryUI theme "header" classes ('fg-toolbar ui-widget-header ui-corner-tl ui-corner-tr ui-helper-clearfix')</li> + * <li>'F' - jQueryUI theme "footer" classes ('fg-toolbar ui-widget-header ui-corner-bl ui-corner-br ui-helper-clearfix')</li> + * </ul> + * </li> + * <li>The following syntax is expected: + * <ul> + * <li>'<' and '>' - div elements</li> + * <li>'<"class" and '>' - div with a class</li> + * <li>'<"#id" and '>' - div with an ID</li> + * </ul> + * </li> + * <li>Examples: + * <ul> + * <li>'<"wrapper"flipt>'</li> + * <li>'<lf<t>ip>'</li> + * </ul> + * </li> + * </ul> + * @type string + * @default lfrtip <i>(when `jQueryUI` is false)</i> <b>or</b> + * <"H"lfr>t<"F"ip> <i>(when `jQueryUI` is true)</i> + * + * @dtopt Options + * @name DataTable.defaults.dom + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "dom": '<"top"i>rt<"bottom"flp><"clear">' + * } ); + * } ); + */ + "sDom": "lfrtip", + + + /** + * Search delay option. This will throttle full table searches that use the + * DataTables provided search input element (it does not effect calls to + * `dt-api search()`, providing a delay before the search is made. + * @type integer + * @default 0 + * + * @dtopt Options + * @name DataTable.defaults.searchDelay + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "searchDelay": 200 + * } ); + * } ) + */ + "searchDelay": null, + + + /** + * DataTables features six different built-in options for the buttons to + * display for pagination control: + * + * * `numbers` - Page number buttons only + * * `simple` - 'Previous' and 'Next' buttons only + * * 'simple_numbers` - 'Previous' and 'Next' buttons, plus page numbers + * * `full` - 'First', 'Previous', 'Next' and 'Last' buttons + * * `full_numbers` - 'First', 'Previous', 'Next' and 'Last' buttons, plus page numbers + * * `first_last_numbers` - 'First' and 'Last' buttons, plus page numbers + * + * Further methods can be added using {@link DataTable.ext.oPagination}. + * @type string + * @default simple_numbers + * + * @dtopt Options + * @name DataTable.defaults.pagingType + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "pagingType": "full_numbers" + * } ); + * } ) + */ + "sPaginationType": "simple_numbers", + + + /** + * Enable horizontal scrolling. When a table is too wide to fit into a + * certain layout, or you have a large number of columns in the table, you + * can enable x-scrolling to show the table in a viewport, which can be + * scrolled. This property can be `true` which will allow the table to + * scroll horizontally when needed, or any CSS unit, or a number (in which + * case it will be treated as a pixel measurement). Setting as simply `true` + * is recommended. + * @type boolean|string + * @default <i>blank string - i.e. disabled</i> + * + * @dtopt Features + * @name DataTable.defaults.scrollX + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "scrollX": true, + * "scrollCollapse": true + * } ); + * } ); + */ + "sScrollX": "", + + + /** + * This property can be used to force a DataTable to use more width than it + * might otherwise do when x-scrolling is enabled. For example if you have a + * table which requires to be well spaced, this parameter is useful for + * "over-sizing" the table, and thus forcing scrolling. This property can by + * any CSS unit, or a number (in which case it will be treated as a pixel + * measurement). + * @type string + * @default <i>blank string - i.e. disabled</i> + * + * @dtopt Options + * @name DataTable.defaults.scrollXInner + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "scrollX": "100%", + * "scrollXInner": "110%" + * } ); + * } ); + */ + "sScrollXInner": "", + + + /** + * Enable vertical scrolling. Vertical scrolling will constrain the DataTable + * to the given height, and enable scrolling for any data which overflows the + * current viewport. This can be used as an alternative to paging to display + * a lot of data in a small area (although paging and scrolling can both be + * enabled at the same time). This property can be any CSS unit, or a number + * (in which case it will be treated as a pixel measurement). + * @type string + * @default <i>blank string - i.e. disabled</i> + * + * @dtopt Features + * @name DataTable.defaults.scrollY + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "scrollY": "200px", + * "paginate": false + * } ); + * } ); + */ + "sScrollY": "", + + + /** + * __Deprecated__ The functionality provided by this parameter has now been + * superseded by that provided through `ajax`, which should be used instead. + * + * Set the HTTP method that is used to make the Ajax call for server-side + * processing or Ajax sourced data. + * @type string + * @default GET + * + * @dtopt Options + * @dtopt Server-side + * @name DataTable.defaults.serverMethod + * + * @deprecated 1.10. Please use `ajax` for this functionality now. + */ + "sServerMethod": "GET", + + + /** + * DataTables makes use of renderers when displaying HTML elements for + * a table. These renderers can be added or modified by plug-ins to + * generate suitable mark-up for a site. For example the Bootstrap + * integration plug-in for DataTables uses a paging button renderer to + * display pagination buttons in the mark-up required by Bootstrap. + * + * For further information about the renderers available see + * DataTable.ext.renderer + * @type string|object + * @default null + * + * @name DataTable.defaults.renderer + * + */ + "renderer": null, + + + /** + * Set the data property name that DataTables should use to get a row's id + * to set as the `id` property in the node. + * @type string + * @default DT_RowId + * + * @name DataTable.defaults.rowId + */ + "rowId": "DT_RowId" + }; + + _fnHungarianMap( DataTable.defaults ); + + + + /* + * Developer note - See note in model.defaults.js about the use of Hungarian + * notation and camel case. + */ + + /** + * Column options that can be given to DataTables at initialisation time. + * @namespace + */ + DataTable.defaults.column = { + /** + * Define which column(s) an order will occur on for this column. This + * allows a column's ordering to take multiple columns into account when + * doing a sort or use the data from a different column. For example first + * name / last name columns make sense to do a multi-column sort over the + * two columns. + * @type array|int + * @default null <i>Takes the value of the column index automatically</i> + * + * @name DataTable.defaults.column.orderData + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "orderData": [ 0, 1 ], "targets": [ 0 ] }, + * { "orderData": [ 1, 0 ], "targets": [ 1 ] }, + * { "orderData": 2, "targets": [ 2 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "orderData": [ 0, 1 ] }, + * { "orderData": [ 1, 0 ] }, + * { "orderData": 2 }, + * null, + * null + * ] + * } ); + * } ); + */ + "aDataSort": null, + "iDataSort": -1, + + + /** + * You can control the default ordering direction, and even alter the + * behaviour of the sort handler (i.e. only allow ascending ordering etc) + * using this parameter. + * @type array + * @default [ 'asc', 'desc' ] + * + * @name DataTable.defaults.column.orderSequence + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "orderSequence": [ "asc" ], "targets": [ 1 ] }, + * { "orderSequence": [ "desc", "asc", "asc" ], "targets": [ 2 ] }, + * { "orderSequence": [ "desc" ], "targets": [ 3 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * null, + * { "orderSequence": [ "asc" ] }, + * { "orderSequence": [ "desc", "asc", "asc" ] }, + * { "orderSequence": [ "desc" ] }, + * null + * ] + * } ); + * } ); + */ + "asSorting": [ 'asc', 'desc' ], + + + /** + * Enable or disable filtering on the data in this column. + * @type boolean + * @default true + * + * @name DataTable.defaults.column.searchable + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "searchable": false, "targets": [ 0 ] } + * ] } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "searchable": false }, + * null, + * null, + * null, + * null + * ] } ); + * } ); + */ + "bSearchable": true, + + + /** + * Enable or disable ordering on this column. + * @type boolean + * @default true + * + * @name DataTable.defaults.column.orderable + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "orderable": false, "targets": [ 0 ] } + * ] } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "orderable": false }, + * null, + * null, + * null, + * null + * ] } ); + * } ); + */ + "bSortable": true, + + + /** + * Enable or disable the display of this column. + * @type boolean + * @default true + * + * @name DataTable.defaults.column.visible + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "visible": false, "targets": [ 0 ] } + * ] } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "visible": false }, + * null, + * null, + * null, + * null + * ] } ); + * } ); + */ + "bVisible": true, + + + /** + * Developer definable function that is called whenever a cell is created (Ajax source, + * etc) or processed for input (DOM source). This can be used as a compliment to mRender + * allowing you to modify the DOM element (add background colour for example) when the + * element is available. + * @type function + * @param {element} td The TD node that has been created + * @param {*} cellData The Data for the cell + * @param {array|object} rowData The data for the whole row + * @param {int} row The row index for the aoData data store + * @param {int} col The column index for aoColumns + * + * @name DataTable.defaults.column.createdCell + * @dtopt Columns + * + * @example + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [3], + * "createdCell": function (td, cellData, rowData, row, col) { + * if ( cellData == "1.7" ) { + * $(td).css('color', 'blue') + * } + * } + * } ] + * }); + * } ); + */ + "fnCreatedCell": null, + + + /** + * This parameter has been replaced by `data` in DataTables to ensure naming + * consistency. `dataProp` can still be used, as there is backwards + * compatibility in DataTables for this option, but it is strongly + * recommended that you use `data` in preference to `dataProp`. + * @name DataTable.defaults.column.dataProp + */ + + + /** + * This property can be used to read data from any data source property, + * including deeply nested objects / properties. `data` can be given in a + * number of different ways which effect its behaviour: + * + * * `integer` - treated as an array index for the data source. This is the + * default that DataTables uses (incrementally increased for each column). + * * `string` - read an object property from the data source. There are + * three 'special' options that can be used in the string to alter how + * DataTables reads the data from the source object: + * * `.` - Dotted Javascript notation. Just as you use a `.` in + * Javascript to read from nested objects, so to can the options + * specified in `data`. For example: `browser.version` or + * `browser.name`. If your object parameter name contains a period, use + * `\\` to escape it - i.e. `first\\.name`. + * * `[]` - Array notation. DataTables can automatically combine data + * from and array source, joining the data with the characters provided + * between the two brackets. For example: `name[, ]` would provide a + * comma-space separated list from the source array. If no characters + * are provided between the brackets, the original array source is + * returned. + * * `()` - Function notation. Adding `()` to the end of a parameter will + * execute a function of the name given. For example: `browser()` for a + * simple function on the data source, `browser.version()` for a + * function in a nested property or even `browser().version` to get an + * object property if the function called returns an object. Note that + * function notation is recommended for use in `render` rather than + * `data` as it is much simpler to use as a renderer. + * * `null` - use the original data source for the row rather than plucking + * data directly from it. This action has effects on two other + * initialisation options: + * * `defaultContent` - When null is given as the `data` option and + * `defaultContent` is specified for the column, the value defined by + * `defaultContent` will be used for the cell. + * * `render` - When null is used for the `data` option and the `render` + * option is specified for the column, the whole data source for the + * row is used for the renderer. + * * `function` - the function given will be executed whenever DataTables + * needs to set or get the data for a cell in the column. The function + * takes three parameters: + * * Parameters: + * * `{array|object}` The data source for the row + * * `{string}` The type call data requested - this will be 'set' when + * setting data or 'filter', 'display', 'type', 'sort' or undefined + * when gathering data. Note that when `undefined` is given for the + * type DataTables expects to get the raw data for the object back< + * * `{*}` Data to set when the second parameter is 'set'. + * * Return: + * * The return value from the function is not required when 'set' is + * the type of call, but otherwise the return is what will be used + * for the data requested. + * + * Note that `data` is a getter and setter option. If you just require + * formatting of data for output, you will likely want to use `render` which + * is simply a getter and thus simpler to use. + * + * Note that prior to DataTables 1.9.2 `data` was called `mDataProp`. The + * name change reflects the flexibility of this property and is consistent + * with the naming of mRender. If 'mDataProp' is given, then it will still + * be used by DataTables, as it automatically maps the old name to the new + * if required. + * + * @type string|int|function|null + * @default null <i>Use automatically calculated column index</i> + * + * @name DataTable.defaults.column.data + * @dtopt Columns + * + * @example + * // Read table data from objects + * // JSON structure for each row: + * // { + * // "engine": {value}, + * // "browser": {value}, + * // "platform": {value}, + * // "version": {value}, + * // "grade": {value} + * // } + * $(document).ready( function() { + * $('#example').dataTable( { + * "ajaxSource": "sources/objects.txt", + * "columns": [ + * { "data": "engine" }, + * { "data": "browser" }, + * { "data": "platform" }, + * { "data": "version" }, + * { "data": "grade" } + * ] + * } ); + * } ); + * + * @example + * // Read information from deeply nested objects + * // JSON structure for each row: + * // { + * // "engine": {value}, + * // "browser": {value}, + * // "platform": { + * // "inner": {value} + * // }, + * // "details": [ + * // {value}, {value} + * // ] + * // } + * $(document).ready( function() { + * $('#example').dataTable( { + * "ajaxSource": "sources/deep.txt", + * "columns": [ + * { "data": "engine" }, + * { "data": "browser" }, + * { "data": "platform.inner" }, + * { "data": "details.0" }, + * { "data": "details.1" } + * ] + * } ); + * } ); + * + * @example + * // Using `data` as a function to provide different information for + * // sorting, filtering and display. In this case, currency (price) + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": function ( source, type, val ) { + * if (type === 'set') { + * source.price = val; + * // Store the computed display and filter values for efficiency + * source.price_display = val=="" ? "" : "$"+numberFormat(val); + * source.price_filter = val=="" ? "" : "$"+numberFormat(val)+" "+val; + * return; + * } + * else if (type === 'display') { + * return source.price_display; + * } + * else if (type === 'filter') { + * return source.price_filter; + * } + * // 'sort', 'type' and undefined all just use the integer + * return source.price; + * } + * } ] + * } ); + * } ); + * + * @example + * // Using default content + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": null, + * "defaultContent": "Click to edit" + * } ] + * } ); + * } ); + * + * @example + * // Using array notation - outputting a list from an array + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": "name[, ]" + * } ] + * } ); + * } ); + * + */ + "mData": null, + + + /** + * This property is the rendering partner to `data` and it is suggested that + * when you want to manipulate data for display (including filtering, + * sorting etc) without altering the underlying data for the table, use this + * property. `render` can be considered to be the the read only companion to + * `data` which is read / write (then as such more complex). Like `data` + * this option can be given in a number of different ways to effect its + * behaviour: + * + * * `integer` - treated as an array index for the data source. This is the + * default that DataTables uses (incrementally increased for each column). + * * `string` - read an object property from the data source. There are + * three 'special' options that can be used in the string to alter how + * DataTables reads the data from the source object: + * * `.` - Dotted Javascript notation. Just as you use a `.` in + * Javascript to read from nested objects, so to can the options + * specified in `data`. For example: `browser.version` or + * `browser.name`. If your object parameter name contains a period, use + * `\\` to escape it - i.e. `first\\.name`. + * * `[]` - Array notation. DataTables can automatically combine data + * from and array source, joining the data with the characters provided + * between the two brackets. For example: `name[, ]` would provide a + * comma-space separated list from the source array. If no characters + * are provided between the brackets, the original array source is + * returned. + * * `()` - Function notation. Adding `()` to the end of a parameter will + * execute a function of the name given. For example: `browser()` for a + * simple function on the data source, `browser.version()` for a + * function in a nested property or even `browser().version` to get an + * object property if the function called returns an object. + * * `object` - use different data for the different data types requested by + * DataTables ('filter', 'display', 'type' or 'sort'). The property names + * of the object is the data type the property refers to and the value can + * defined using an integer, string or function using the same rules as + * `render` normally does. Note that an `_` option _must_ be specified. + * This is the default value to use if you haven't specified a value for + * the data type requested by DataTables. + * * `function` - the function given will be executed whenever DataTables + * needs to set or get the data for a cell in the column. The function + * takes three parameters: + * * Parameters: + * * {array|object} The data source for the row (based on `data`) + * * {string} The type call data requested - this will be 'filter', + * 'display', 'type' or 'sort'. + * * {array|object} The full data source for the row (not based on + * `data`) + * * Return: + * * The return value from the function is what will be used for the + * data requested. + * + * @type string|int|function|object|null + * @default null Use the data source value. + * + * @name DataTable.defaults.column.render + * @dtopt Columns + * + * @example + * // Create a comma separated list from an array of objects + * $(document).ready( function() { + * $('#example').dataTable( { + * "ajaxSource": "sources/deep.txt", + * "columns": [ + * { "data": "engine" }, + * { "data": "browser" }, + * { + * "data": "platform", + * "render": "[, ].name" + * } + * ] + * } ); + * } ); + * + * @example + * // Execute a function to obtain data + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": null, // Use the full data source object for the renderer's source + * "render": "browserName()" + * } ] + * } ); + * } ); + * + * @example + * // As an object, extracting different data for the different types + * // This would be used with a data source such as: + * // { "phone": 5552368, "phone_filter": "5552368 555-2368", "phone_display": "555-2368" } + * // Here the `phone` integer is used for sorting and type detection, while `phone_filter` + * // (which has both forms) is used for filtering for if a user inputs either format, while + * // the formatted phone number is the one that is shown in the table. + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": null, // Use the full data source object for the renderer's source + * "render": { + * "_": "phone", + * "filter": "phone_filter", + * "display": "phone_display" + * } + * } ] + * } ); + * } ); + * + * @example + * // Use as a function to create a link from the data source + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "data": "download_link", + * "render": function ( data, type, full ) { + * return '<a href="'+data+'">Download</a>'; + * } + * } ] + * } ); + * } ); + */ + "mRender": null, + + + /** + * Change the cell type created for the column - either TD cells or TH cells. This + * can be useful as TH cells have semantic meaning in the table body, allowing them + * to act as a header for a row (you may wish to add scope='row' to the TH elements). + * @type string + * @default td + * + * @name DataTable.defaults.column.cellType + * @dtopt Columns + * + * @example + * // Make the first column use TH cells + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ { + * "targets": [ 0 ], + * "cellType": "th" + * } ] + * } ); + * } ); + */ + "sCellType": "td", + + + /** + * Class to give to each cell in this column. + * @type string + * @default <i>Empty string</i> + * + * @name DataTable.defaults.column.class + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "class": "my_class", "targets": [ 0 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "class": "my_class" }, + * null, + * null, + * null, + * null + * ] + * } ); + * } ); + */ + "sClass": "", + + /** + * When DataTables calculates the column widths to assign to each column, + * it finds the longest string in each column and then constructs a + * temporary table and reads the widths from that. The problem with this + * is that "mmm" is much wider then "iiii", but the latter is a longer + * string - thus the calculation can go wrong (doing it properly and putting + * it into an DOM object and measuring that is horribly(!) slow). Thus as + * a "work around" we provide this option. It will append its value to the + * text that is found to be the longest string for the column - i.e. padding. + * Generally you shouldn't need this! + * @type string + * @default <i>Empty string<i> + * + * @name DataTable.defaults.column.contentPadding + * @dtopt Columns + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * null, + * null, + * null, + * { + * "contentPadding": "mmm" + * } + * ] + * } ); + * } ); + */ + "sContentPadding": "", + + + /** + * Allows a default value to be given for a column's data, and will be used + * whenever a null data source is encountered (this can be because `data` + * is set to null, or because the data source itself is null). + * @type string + * @default null + * + * @name DataTable.defaults.column.defaultContent + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { + * "data": null, + * "defaultContent": "Edit", + * "targets": [ -1 ] + * } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * null, + * null, + * null, + * { + * "data": null, + * "defaultContent": "Edit" + * } + * ] + * } ); + * } ); + */ + "sDefaultContent": null, + + + /** + * This parameter is only used in DataTables' server-side processing. It can + * be exceptionally useful to know what columns are being displayed on the + * client side, and to map these to database fields. When defined, the names + * also allow DataTables to reorder information from the server if it comes + * back in an unexpected order (i.e. if you switch your columns around on the + * client-side, your server-side code does not also need updating). + * @type string + * @default <i>Empty string</i> + * + * @name DataTable.defaults.column.name + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "name": "engine", "targets": [ 0 ] }, + * { "name": "browser", "targets": [ 1 ] }, + * { "name": "platform", "targets": [ 2 ] }, + * { "name": "version", "targets": [ 3 ] }, + * { "name": "grade", "targets": [ 4 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "name": "engine" }, + * { "name": "browser" }, + * { "name": "platform" }, + * { "name": "version" }, + * { "name": "grade" } + * ] + * } ); + * } ); + */ + "sName": "", + + + /** + * Defines a data source type for the ordering which can be used to read + * real-time information from the table (updating the internally cached + * version) prior to ordering. This allows ordering to occur on user + * editable elements such as form inputs. + * @type string + * @default std + * + * @name DataTable.defaults.column.orderDataType + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "orderDataType": "dom-text", "targets": [ 2, 3 ] }, + * { "type": "numeric", "targets": [ 3 ] }, + * { "orderDataType": "dom-select", "targets": [ 4 ] }, + * { "orderDataType": "dom-checkbox", "targets": [ 5 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * null, + * null, + * { "orderDataType": "dom-text" }, + * { "orderDataType": "dom-text", "type": "numeric" }, + * { "orderDataType": "dom-select" }, + * { "orderDataType": "dom-checkbox" } + * ] + * } ); + * } ); + */ + "sSortDataType": "std", + + + /** + * The title of this column. + * @type string + * @default null <i>Derived from the 'TH' value for this column in the + * original HTML table.</i> + * + * @name DataTable.defaults.column.title + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "title": "My column title", "targets": [ 0 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "title": "My column title" }, + * null, + * null, + * null, + * null + * ] + * } ); + * } ); + */ + "sTitle": null, + + + /** + * The type allows you to specify how the data for this column will be + * ordered. Four types (string, numeric, date and html (which will strip + * HTML tags before ordering)) are currently available. Note that only date + * formats understood by Javascript's Date() object will be accepted as type + * date. For example: "Mar 26, 2008 5:03 PM". May take the values: 'string', + * 'numeric', 'date' or 'html' (by default). Further types can be adding + * through plug-ins. + * @type string + * @default null <i>Auto-detected from raw data</i> + * + * @name DataTable.defaults.column.type + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "type": "html", "targets": [ 0 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "type": "html" }, + * null, + * null, + * null, + * null + * ] + * } ); + * } ); + */ + "sType": null, + + + /** + * Defining the width of the column, this parameter may take any CSS value + * (3em, 20px etc). DataTables applies 'smart' widths to columns which have not + * been given a specific width through this interface ensuring that the table + * remains readable. + * @type string + * @default null <i>Automatic</i> + * + * @name DataTable.defaults.column.width + * @dtopt Columns + * + * @example + * // Using `columnDefs` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columnDefs": [ + * { "width": "20%", "targets": [ 0 ] } + * ] + * } ); + * } ); + * + * @example + * // Using `columns` + * $(document).ready( function() { + * $('#example').dataTable( { + * "columns": [ + * { "width": "20%" }, + * null, + * null, + * null, + * null + * ] + * } ); + * } ); + */ + "sWidth": null + }; + + _fnHungarianMap( DataTable.defaults.column ); + + + + /** + * DataTables settings object - this holds all the information needed for a + * given table, including configuration, data and current application of the + * table options. DataTables does not have a single instance for each DataTable + * with the settings attached to that instance, but rather instances of the + * DataTable "class" are created on-the-fly as needed (typically by a + * $().dataTable() call) and the settings object is then applied to that + * instance. + * + * Note that this object is related to {@link DataTable.defaults} but this + * one is the internal data store for DataTables's cache of columns. It should + * NOT be manipulated outside of DataTables. Any configuration should be done + * through the initialisation options. + * @namespace + * @todo Really should attach the settings object to individual instances so we + * don't need to create new instances on each $().dataTable() call (if the + * table already exists). It would also save passing oSettings around and + * into every single function. However, this is a very significant + * architecture change for DataTables and will almost certainly break + * backwards compatibility with older installations. This is something that + * will be done in 2.0. + */ + DataTable.models.oSettings = { + /** + * Primary features of DataTables and their enablement state. + * @namespace + */ + "oFeatures": { + + /** + * Flag to say if DataTables should automatically try to calculate the + * optimum table and columns widths (true) or not (false). + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bAutoWidth": null, + + /** + * Delay the creation of TR and TD elements until they are actually + * needed by a driven page draw. This can give a significant speed + * increase for Ajax source and Javascript source data, but makes no + * difference at all for DOM and server-side processing tables. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bDeferRender": null, + + /** + * Enable filtering on the table or not. Note that if this is disabled + * then there is no filtering at all on the table, including fnFilter. + * To just remove the filtering input use sDom and remove the 'f' option. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bFilter": null, + + /** + * Table information element (the 'Showing x of y records' div) enable + * flag. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bInfo": null, + + /** + * Present a user control allowing the end user to change the page size + * when pagination is enabled. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bLengthChange": null, + + /** + * Pagination enabled or not. Note that if this is disabled then length + * changing must also be disabled. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bPaginate": null, + + /** + * Processing indicator enable flag whenever DataTables is enacting a + * user request - typically an Ajax request for server-side processing. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bProcessing": null, + + /** + * Server-side processing enabled flag - when enabled DataTables will + * get all data from the server for every draw - there is no filtering, + * sorting or paging done on the client-side. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bServerSide": null, + + /** + * Sorting enablement flag. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bSort": null, + + /** + * Multi-column sorting + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bSortMulti": null, + + /** + * Apply a class to the columns which are being sorted to provide a + * visual highlight or not. This can slow things down when enabled since + * there is a lot of DOM interaction. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bSortClasses": null, + + /** + * State saving enablement flag. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bStateSave": null + }, + + + /** + * Scrolling settings for a table. + * @namespace + */ + "oScroll": { + /** + * When the table is shorter in height than sScrollY, collapse the + * table container down to the height of the table (when true). + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bCollapse": null, + + /** + * Width of the scrollbar for the web-browser's platform. Calculated + * during table initialisation. + * @type int + * @default 0 + */ + "iBarWidth": 0, + + /** + * Viewport width for horizontal scrolling. Horizontal scrolling is + * disabled if an empty string. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + */ + "sX": null, + + /** + * Width to expand the table to when using x-scrolling. Typically you + * should not need to use this. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + * @deprecated + */ + "sXInner": null, + + /** + * Viewport height for vertical scrolling. Vertical scrolling is disabled + * if an empty string. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + */ + "sY": null + }, + + /** + * Language information for the table. + * @namespace + * @extends DataTable.defaults.oLanguage + */ + "oLanguage": { + /** + * Information callback function. See + * {@link DataTable.defaults.fnInfoCallback} + * @type function + * @default null + */ + "fnInfoCallback": null + }, + + /** + * Browser support parameters + * @namespace + */ + "oBrowser": { + /** + * Indicate if the browser incorrectly calculates width:100% inside a + * scrolling element (IE6/7) + * @type boolean + * @default false + */ + "bScrollOversize": false, + + /** + * Determine if the vertical scrollbar is on the right or left of the + * scrolling container - needed for rtl language layout, although not + * all browsers move the scrollbar (Safari). + * @type boolean + * @default false + */ + "bScrollbarLeft": false, + + /** + * Flag for if `getBoundingClientRect` is fully supported or not + * @type boolean + * @default false + */ + "bBounding": false, + + /** + * Browser scrollbar width + * @type integer + * @default 0 + */ + "barWidth": 0 + }, + + + "ajax": null, + + + /** + * Array referencing the nodes which are used for the features. The + * parameters of this object match what is allowed by sDom - i.e. + * <ul> + * <li>'l' - Length changing</li> + * <li>'f' - Filtering input</li> + * <li>'t' - The table!</li> + * <li>'i' - Information</li> + * <li>'p' - Pagination</li> + * <li>'r' - pRocessing</li> + * </ul> + * @type array + * @default [] + */ + "aanFeatures": [], + + /** + * Store data information - see {@link DataTable.models.oRow} for detailed + * information. + * @type array + * @default [] + */ + "aoData": [], + + /** + * Array of indexes which are in the current display (after filtering etc) + * @type array + * @default [] + */ + "aiDisplay": [], + + /** + * Array of indexes for display - no filtering + * @type array + * @default [] + */ + "aiDisplayMaster": [], + + /** + * Map of row ids to data indexes + * @type object + * @default {} + */ + "aIds": {}, + + /** + * Store information about each column that is in use + * @type array + * @default [] + */ + "aoColumns": [], + + /** + * Store information about the table's header + * @type array + * @default [] + */ + "aoHeader": [], + + /** + * Store information about the table's footer + * @type array + * @default [] + */ + "aoFooter": [], + + /** + * Store the applied global search information in case we want to force a + * research or compare the old search to a new one. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @namespace + * @extends DataTable.models.oSearch + */ + "oPreviousSearch": {}, + + /** + * Store the applied search for each column - see + * {@link DataTable.models.oSearch} for the format that is used for the + * filtering information for each column. + * @type array + * @default [] + */ + "aoPreSearchCols": [], + + /** + * Sorting that is applied to the table. Note that the inner arrays are + * used in the following manner: + * <ul> + * <li>Index 0 - column number</li> + * <li>Index 1 - current sorting direction</li> + * </ul> + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type array + * @todo These inner arrays should really be objects + */ + "aaSorting": null, + + /** + * Sorting that is always applied to the table (i.e. prefixed in front of + * aaSorting). + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type array + * @default [] + */ + "aaSortingFixed": [], + + /** + * Classes to use for the striping of a table. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type array + * @default [] + */ + "asStripeClasses": null, + + /** + * If restoring a table - we should restore its striping classes as well + * @type array + * @default [] + */ + "asDestroyStripes": [], + + /** + * If restoring a table - we should restore its width + * @type int + * @default 0 + */ + "sDestroyWidth": 0, + + /** + * Callback functions array for every time a row is inserted (i.e. on a draw). + * @type array + * @default [] + */ + "aoRowCallback": [], + + /** + * Callback functions for the header on each draw. + * @type array + * @default [] + */ + "aoHeaderCallback": [], + + /** + * Callback function for the footer on each draw. + * @type array + * @default [] + */ + "aoFooterCallback": [], + + /** + * Array of callback functions for draw callback functions + * @type array + * @default [] + */ + "aoDrawCallback": [], + + /** + * Array of callback functions for row created function + * @type array + * @default [] + */ + "aoRowCreatedCallback": [], + + /** + * Callback functions for just before the table is redrawn. A return of + * false will be used to cancel the draw. + * @type array + * @default [] + */ + "aoPreDrawCallback": [], + + /** + * Callback functions for when the table has been initialised. + * @type array + * @default [] + */ + "aoInitComplete": [], + + + /** + * Callbacks for modifying the settings to be stored for state saving, prior to + * saving state. + * @type array + * @default [] + */ + "aoStateSaveParams": [], + + /** + * Callbacks for modifying the settings that have been stored for state saving + * prior to using the stored values to restore the state. + * @type array + * @default [] + */ + "aoStateLoadParams": [], + + /** + * Callbacks for operating on the settings object once the saved state has been + * loaded + * @type array + * @default [] + */ + "aoStateLoaded": [], + + /** + * Cache the table ID for quick access + * @type string + * @default <i>Empty string</i> + */ + "sTableId": "", + + /** + * The TABLE node for the main table + * @type node + * @default null + */ + "nTable": null, + + /** + * Permanent ref to the thead element + * @type node + * @default null + */ + "nTHead": null, + + /** + * Permanent ref to the tfoot element - if it exists + * @type node + * @default null + */ + "nTFoot": null, + + /** + * Permanent ref to the tbody element + * @type node + * @default null + */ + "nTBody": null, + + /** + * Cache the wrapper node (contains all DataTables controlled elements) + * @type node + * @default null + */ + "nTableWrapper": null, + + /** + * Indicate if when using server-side processing the loading of data + * should be deferred until the second draw. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + * @default false + */ + "bDeferLoading": false, + + /** + * Indicate if all required information has been read in + * @type boolean + * @default false + */ + "bInitialised": false, + + /** + * Information about open rows. Each object in the array has the parameters + * 'nTr' and 'nParent' + * @type array + * @default [] + */ + "aoOpenRows": [], + + /** + * Dictate the positioning of DataTables' control elements - see + * {@link DataTable.model.oInit.sDom}. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + * @default null + */ + "sDom": null, + + /** + * Search delay (in mS) + * @type integer + * @default null + */ + "searchDelay": null, + + /** + * Which type of pagination should be used. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + * @default two_button + */ + "sPaginationType": "two_button", + + /** + * The state duration (for `stateSave`) in seconds. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type int + * @default 0 + */ + "iStateDuration": 0, + + /** + * Array of callback functions for state saving. Each array element is an + * object with the following parameters: + * <ul> + * <li>function:fn - function to call. Takes two parameters, oSettings + * and the JSON string to save that has been thus far created. Returns + * a JSON string to be inserted into a json object + * (i.e. '"param": [ 0, 1, 2]')</li> + * <li>string:sName - name of callback</li> + * </ul> + * @type array + * @default [] + */ + "aoStateSave": [], + + /** + * Array of callback functions for state loading. Each array element is an + * object with the following parameters: + * <ul> + * <li>function:fn - function to call. Takes two parameters, oSettings + * and the object stored. May return false to cancel state loading</li> + * <li>string:sName - name of callback</li> + * </ul> + * @type array + * @default [] + */ + "aoStateLoad": [], + + /** + * State that was saved. Useful for back reference + * @type object + * @default null + */ + "oSavedState": null, + + /** + * State that was loaded. Useful for back reference + * @type object + * @default null + */ + "oLoadedState": null, + + /** + * Source url for AJAX data for the table. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + * @default null + */ + "sAjaxSource": null, + + /** + * Property from a given object from which to read the table data from. This + * can be an empty string (when not server-side processing), in which case + * it is assumed an an array is given directly. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + */ + "sAjaxDataProp": null, + + /** + * The last jQuery XHR object that was used for server-side data gathering. + * This can be used for working with the XHR information in one of the + * callbacks + * @type object + * @default null + */ + "jqXHR": null, + + /** + * JSON returned from the server in the last Ajax request + * @type object + * @default undefined + */ + "json": undefined, + + /** + * Data submitted as part of the last Ajax request + * @type object + * @default undefined + */ + "oAjaxData": undefined, + + /** + * Function to get the server-side data. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type function + */ + "fnServerData": null, + + /** + * Functions which are called prior to sending an Ajax request so extra + * parameters can easily be sent to the server + * @type array + * @default [] + */ + "aoServerParams": [], + + /** + * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if + * required). + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type string + */ + "sServerMethod": null, + + /** + * Format numbers for display. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type function + */ + "fnFormatNumber": null, + + /** + * List of options that can be used for the user selectable length menu. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type array + * @default [] + */ + "aLengthMenu": null, + + /** + * Counter for the draws that the table does. Also used as a tracker for + * server-side processing + * @type int + * @default 0 + */ + "iDraw": 0, + + /** + * Indicate if a redraw is being done - useful for Ajax + * @type boolean + * @default false + */ + "bDrawing": false, + + /** + * Draw index (iDraw) of the last error when parsing the returned data + * @type int + * @default -1 + */ + "iDrawError": -1, + + /** + * Paging display length + * @type int + * @default 10 + */ + "_iDisplayLength": 10, + + /** + * Paging start point - aiDisplay index + * @type int + * @default 0 + */ + "_iDisplayStart": 0, + + /** + * Server-side processing - number of records in the result set + * (i.e. before filtering), Use fnRecordsTotal rather than + * this property to get the value of the number of records, regardless of + * the server-side processing setting. + * @type int + * @default 0 + * @private + */ + "_iRecordsTotal": 0, + + /** + * Server-side processing - number of records in the current display set + * (i.e. after filtering). Use fnRecordsDisplay rather than + * this property to get the value of the number of records, regardless of + * the server-side processing setting. + * @type boolean + * @default 0 + * @private + */ + "_iRecordsDisplay": 0, + + /** + * The classes to use for the table + * @type object + * @default {} + */ + "oClasses": {}, + + /** + * Flag attached to the settings object so you can check in the draw + * callback if filtering has been done in the draw. Deprecated in favour of + * events. + * @type boolean + * @default false + * @deprecated + */ + "bFiltered": false, + + /** + * Flag attached to the settings object so you can check in the draw + * callback if sorting has been done in the draw. Deprecated in favour of + * events. + * @type boolean + * @default false + * @deprecated + */ + "bSorted": false, + + /** + * Indicate that if multiple rows are in the header and there is more than + * one unique cell per column, if the top one (true) or bottom one (false) + * should be used for sorting / title by DataTables. + * Note that this parameter will be set by the initialisation routine. To + * set a default use {@link DataTable.defaults}. + * @type boolean + */ + "bSortCellsTop": null, + + /** + * Initialisation object that is used for the table + * @type object + * @default null + */ + "oInit": null, + + /** + * Destroy callback functions - for plug-ins to attach themselves to the + * destroy so they can clean up markup and events. + * @type array + * @default [] + */ + "aoDestroyCallback": [], + + + /** + * Get the number of records in the current record set, before filtering + * @type function + */ + "fnRecordsTotal": function () + { + return _fnDataSource( this ) == 'ssp' ? + this._iRecordsTotal * 1 : + this.aiDisplayMaster.length; + }, + + /** + * Get the number of records in the current record set, after filtering + * @type function + */ + "fnRecordsDisplay": function () + { + return _fnDataSource( this ) == 'ssp' ? + this._iRecordsDisplay * 1 : + this.aiDisplay.length; + }, + + /** + * Get the display end point - aiDisplay index + * @type function + */ + "fnDisplayEnd": function () + { + var + len = this._iDisplayLength, + start = this._iDisplayStart, + calc = start + len, + records = this.aiDisplay.length, + features = this.oFeatures, + paginate = features.bPaginate; + + if ( features.bServerSide ) { + return paginate === false || len === -1 ? + start + records : + Math.min( start+len, this._iRecordsDisplay ); + } + else { + return ! paginate || calc>records || len===-1 ? + records : + calc; + } + }, + + /** + * The DataTables object for this table + * @type object + * @default null + */ + "oInstance": null, + + /** + * Unique identifier for each instance of the DataTables object. If there + * is an ID on the table node, then it takes that value, otherwise an + * incrementing internal counter is used. + * @type string + * @default null + */ + "sInstance": null, + + /** + * tabindex attribute value that is added to DataTables control elements, allowing + * keyboard navigation of the table and its controls. + */ + "iTabIndex": 0, + + /** + * DIV container for the footer scrolling table if scrolling + */ + "nScrollHead": null, + + /** + * DIV container for the footer scrolling table if scrolling + */ + "nScrollFoot": null, + + /** + * Last applied sort + * @type array + * @default [] + */ + "aLastSort": [], + + /** + * Stored plug-in instances + * @type object + * @default {} + */ + "oPlugins": {}, + + /** + * Function used to get a row's id from the row's data + * @type function + * @default null + */ + "rowIdFn": null, + + /** + * Data location where to store a row's id + * @type string + * @default null + */ + "rowId": null + }; + + /** + * Extension object for DataTables that is used to provide all extension + * options. + * + * Note that the `DataTable.ext` object is available through + * `jQuery.fn.dataTable.ext` where it may be accessed and manipulated. It is + * also aliased to `jQuery.fn.dataTableExt` for historic reasons. + * @namespace + * @extends DataTable.models.ext + */ + + + /** + * DataTables extensions + * + * This namespace acts as a collection area for plug-ins that can be used to + * extend DataTables capabilities. Indeed many of the build in methods + * use this method to provide their own capabilities (sorting methods for + * example). + * + * Note that this namespace is aliased to `jQuery.fn.dataTableExt` for legacy + * reasons + * + * @namespace + */ + DataTable.ext = _ext = { + /** + * Buttons. For use with the Buttons extension for DataTables. This is + * defined here so other extensions can define buttons regardless of load + * order. It is _not_ used by DataTables core. + * + * @type object + * @default {} + */ + buttons: {}, + + + /** + * Element class names + * + * @type object + * @default {} + */ + classes: {}, + + + /** + * DataTables build type (expanded by the download builder) + * + * @type string + */ + build:"dt/dt-1.11.5", + + + /** + * Error reporting. + * + * How should DataTables report an error. Can take the value 'alert', + * 'throw', 'none' or a function. + * + * @type string|function + * @default alert + */ + errMode: "alert", + + + /** + * Feature plug-ins. + * + * This is an array of objects which describe the feature plug-ins that are + * available to DataTables. These feature plug-ins are then available for + * use through the `dom` initialisation option. + * + * Each feature plug-in is described by an object which must have the + * following properties: + * + * * `fnInit` - function that is used to initialise the plug-in, + * * `cFeature` - a character so the feature can be enabled by the `dom` + * instillation option. This is case sensitive. + * + * The `fnInit` function has the following input parameters: + * + * 1. `{object}` DataTables settings object: see + * {@link DataTable.models.oSettings} + * + * And the following return is expected: + * + * * {node|null} The element which contains your feature. Note that the + * return may also be void if your plug-in does not require to inject any + * DOM elements into DataTables control (`dom`) - for example this might + * be useful when developing a plug-in which allows table control via + * keyboard entry + * + * @type array + * + * @example + * $.fn.dataTable.ext.features.push( { + * "fnInit": function( oSettings ) { + * return new TableTools( { "oDTSettings": oSettings } ); + * }, + * "cFeature": "T" + * } ); + */ + feature: [], + + + /** + * Row searching. + * + * This method of searching is complimentary to the default type based + * searching, and a lot more comprehensive as it allows you complete control + * over the searching logic. Each element in this array is a function + * (parameters described below) that is called for every row in the table, + * and your logic decides if it should be included in the searching data set + * or not. + * + * Searching functions have the following input parameters: + * + * 1. `{object}` DataTables settings object: see + * {@link DataTable.models.oSettings} + * 2. `{array|object}` Data for the row to be processed (same as the + * original format that was passed in as the data source, or an array + * from a DOM data source + * 3. `{int}` Row index ({@link DataTable.models.oSettings.aoData}), which + * can be useful to retrieve the `TR` element if you need DOM interaction. + * + * And the following return is expected: + * + * * {boolean} Include the row in the searched result set (true) or not + * (false) + * + * Note that as with the main search ability in DataTables, technically this + * is "filtering", since it is subtractive. However, for consistency in + * naming we call it searching here. + * + * @type array + * @default [] + * + * @example + * // The following example shows custom search being applied to the + * // fourth column (i.e. the data[3] index) based on two input values + * // from the end-user, matching the data in a certain range. + * $.fn.dataTable.ext.search.push( + * function( settings, data, dataIndex ) { + * var min = document.getElementById('min').value * 1; + * var max = document.getElementById('max').value * 1; + * var version = data[3] == "-" ? 0 : data[3]*1; + * + * if ( min == "" && max == "" ) { + * return true; + * } + * else if ( min == "" && version < max ) { + * return true; + * } + * else if ( min < version && "" == max ) { + * return true; + * } + * else if ( min < version && version < max ) { + * return true; + * } + * return false; + * } + * ); + */ + search: [], + + + /** + * Selector extensions + * + * The `selector` option can be used to extend the options available for the + * selector modifier options (`selector-modifier` object data type) that + * each of the three built in selector types offer (row, column and cell + + * their plural counterparts). For example the Select extension uses this + * mechanism to provide an option to select only rows, columns and cells + * that have been marked as selected by the end user (`{selected: true}`), + * which can be used in conjunction with the existing built in selector + * options. + * + * Each property is an array to which functions can be pushed. The functions + * take three attributes: + * + * * Settings object for the host table + * * Options object (`selector-modifier` object type) + * * Array of selected item indexes + * + * The return is an array of the resulting item indexes after the custom + * selector has been applied. + * + * @type object + */ + selector: { + cell: [], + column: [], + row: [] + }, + + + /** + * Internal functions, exposed for used in plug-ins. + * + * Please note that you should not need to use the internal methods for + * anything other than a plug-in (and even then, try to avoid if possible). + * The internal function may change between releases. + * + * @type object + * @default {} + */ + internal: {}, + + + /** + * Legacy configuration options. Enable and disable legacy options that + * are available in DataTables. + * + * @type object + */ + legacy: { + /** + * Enable / disable DataTables 1.9 compatible server-side processing + * requests + * + * @type boolean + * @default null + */ + ajax: null + }, + + + /** + * Pagination plug-in methods. + * + * Each entry in this object is a function and defines which buttons should + * be shown by the pagination rendering method that is used for the table: + * {@link DataTable.ext.renderer.pageButton}. The renderer addresses how the + * buttons are displayed in the document, while the functions here tell it + * what buttons to display. This is done by returning an array of button + * descriptions (what each button will do). + * + * Pagination types (the four built in options and any additional plug-in + * options defined here) can be used through the `paginationType` + * initialisation parameter. + * + * The functions defined take two parameters: + * + * 1. `{int} page` The current page index + * 2. `{int} pages` The number of pages in the table + * + * Each function is expected to return an array where each element of the + * array can be one of: + * + * * `first` - Jump to first page when activated + * * `last` - Jump to last page when activated + * * `previous` - Show previous page when activated + * * `next` - Show next page when activated + * * `{int}` - Show page of the index given + * * `{array}` - A nested array containing the above elements to add a + * containing 'DIV' element (might be useful for styling). + * + * Note that DataTables v1.9- used this object slightly differently whereby + * an object with two functions would be defined for each plug-in. That + * ability is still supported by DataTables 1.10+ to provide backwards + * compatibility, but this option of use is now decremented and no longer + * documented in DataTables 1.10+. + * + * @type object + * @default {} + * + * @example + * // Show previous, next and current page buttons only + * $.fn.dataTableExt.oPagination.current = function ( page, pages ) { + * return [ 'previous', page, 'next' ]; + * }; + */ + pager: {}, + + + renderer: { + pageButton: {}, + header: {} + }, + + + /** + * Ordering plug-ins - custom data source + * + * The extension options for ordering of data available here is complimentary + * to the default type based ordering that DataTables typically uses. It + * allows much greater control over the the data that is being used to + * order a column, but is necessarily therefore more complex. + * + * This type of ordering is useful if you want to do ordering based on data + * live from the DOM (for example the contents of an 'input' element) rather + * than just the static string that DataTables knows of. + * + * The way these plug-ins work is that you create an array of the values you + * wish to be ordering for the column in question and then return that + * array. The data in the array much be in the index order of the rows in + * the table (not the currently ordering order!). Which order data gathering + * function is run here depends on the `dt-init columns.orderDataType` + * parameter that is used for the column (if any). + * + * The functions defined take two parameters: + * + * 1. `{object}` DataTables settings object: see + * {@link DataTable.models.oSettings} + * 2. `{int}` Target column index + * + * Each function is expected to return an array: + * + * * `{array}` Data for the column to be ordering upon + * + * @type array + * + * @example + * // Ordering using `input` node values + * $.fn.dataTable.ext.order['dom-text'] = function ( settings, col ) + * { + * return this.api().column( col, {order:'index'} ).nodes().map( function ( td, i ) { + * return $('input', td).val(); + * } ); + * } + */ + order: {}, + + + /** + * Type based plug-ins. + * + * Each column in DataTables has a type assigned to it, either by automatic + * detection or by direct assignment using the `type` option for the column. + * The type of a column will effect how it is ordering and search (plug-ins + * can also make use of the column type if required). + * + * @namespace + */ + type: { + /** + * Type detection functions. + * + * The functions defined in this object are used to automatically detect + * a column's type, making initialisation of DataTables super easy, even + * when complex data is in the table. + * + * The functions defined take two parameters: + * + * 1. `{*}` Data from the column cell to be analysed + * 2. `{settings}` DataTables settings object. This can be used to + * perform context specific type detection - for example detection + * based on language settings such as using a comma for a decimal + * place. Generally speaking the options from the settings will not + * be required + * + * Each function is expected to return: + * + * * `{string|null}` Data type detected, or null if unknown (and thus + * pass it on to the other type detection functions. + * + * @type array + * + * @example + * // Currency type detection plug-in: + * $.fn.dataTable.ext.type.detect.push( + * function ( data, settings ) { + * // Check the numeric part + * if ( ! data.substring(1).match(/[0-9]/) ) { + * return null; + * } + * + * // Check prefixed by currency + * if ( data.charAt(0) == '$' || data.charAt(0) == '£' ) { + * return 'currency'; + * } + * return null; + * } + * ); + */ + detect: [], + + + /** + * Type based search formatting. + * + * The type based searching functions can be used to pre-format the + * data to be search on. For example, it can be used to strip HTML + * tags or to de-format telephone numbers for numeric only searching. + * + * Note that is a search is not defined for a column of a given type, + * no search formatting will be performed. + * + * Pre-processing of searching data plug-ins - When you assign the sType + * for a column (or have it automatically detected for you by DataTables + * or a type detection plug-in), you will typically be using this for + * custom sorting, but it can also be used to provide custom searching + * by allowing you to pre-processing the data and returning the data in + * the format that should be searched upon. This is done by adding + * functions this object with a parameter name which matches the sType + * for that target column. This is the corollary of <i>afnSortData</i> + * for searching data. + * + * The functions defined take a single parameter: + * + * 1. `{*}` Data from the column cell to be prepared for searching + * + * Each function is expected to return: + * + * * `{string|null}` Formatted string that will be used for the searching. + * + * @type object + * @default {} + * + * @example + * $.fn.dataTable.ext.type.search['title-numeric'] = function ( d ) { + * return d.replace(/\n/g," ").replace( /<.*?>/g, "" ); + * } + */ + search: {}, + + + /** + * Type based ordering. + * + * The column type tells DataTables what ordering to apply to the table + * when a column is sorted upon. The order for each type that is defined, + * is defined by the functions available in this object. + * + * Each ordering option can be described by three properties added to + * this object: + * + * * `{type}-pre` - Pre-formatting function + * * `{type}-asc` - Ascending order function + * * `{type}-desc` - Descending order function + * + * All three can be used together, only `{type}-pre` or only + * `{type}-asc` and `{type}-desc` together. It is generally recommended + * that only `{type}-pre` is used, as this provides the optimal + * implementation in terms of speed, although the others are provided + * for compatibility with existing Javascript sort functions. + * + * `{type}-pre`: Functions defined take a single parameter: + * + * 1. `{*}` Data from the column cell to be prepared for ordering + * + * And return: + * + * * `{*}` Data to be sorted upon + * + * `{type}-asc` and `{type}-desc`: Functions are typical Javascript sort + * functions, taking two parameters: + * + * 1. `{*}` Data to compare to the second parameter + * 2. `{*}` Data to compare to the first parameter + * + * And returning: + * + * * `{*}` Ordering match: <0 if first parameter should be sorted lower + * than the second parameter, ===0 if the two parameters are equal and + * >0 if the first parameter should be sorted height than the second + * parameter. + * + * @type object + * @default {} + * + * @example + * // Numeric ordering of formatted numbers with a pre-formatter + * $.extend( $.fn.dataTable.ext.type.order, { + * "string-pre": function(x) { + * a = (a === "-" || a === "") ? 0 : a.replace( /[^\d\-\.]/g, "" ); + * return parseFloat( a ); + * } + * } ); + * + * @example + * // Case-sensitive string ordering, with no pre-formatting method + * $.extend( $.fn.dataTable.ext.order, { + * "string-case-asc": function(x,y) { + * return ((x < y) ? -1 : ((x > y) ? 1 : 0)); + * }, + * "string-case-desc": function(x,y) { + * return ((x < y) ? 1 : ((x > y) ? -1 : 0)); + * } + * } ); + */ + order: {} + }, + + /** + * Unique DataTables instance counter + * + * @type int + * @private + */ + _unique: 0, + + + // + // Depreciated + // The following properties are retained for backwards compatibility only. + // The should not be used in new projects and will be removed in a future + // version + // + + /** + * Version check function. + * @type function + * @depreciated Since 1.10 + */ + fnVersionCheck: DataTable.fnVersionCheck, + + + /** + * Index for what 'this' index API functions should use + * @type int + * @deprecated Since v1.10 + */ + iApiIndex: 0, + + + /** + * jQuery UI class container + * @type object + * @deprecated Since v1.10 + */ + oJUIClasses: {}, + + + /** + * Software version + * @type string + * @deprecated Since v1.10 + */ + sVersion: DataTable.version + }; + + + // + // Backwards compatibility. Alias to pre 1.10 Hungarian notation counter parts + // + $.extend( _ext, { + afnFiltering: _ext.search, + aTypes: _ext.type.detect, + ofnSearch: _ext.type.search, + oSort: _ext.type.order, + afnSortData: _ext.order, + aoFeatures: _ext.feature, + oApi: _ext.internal, + oStdClasses: _ext.classes, + oPagination: _ext.pager + } ); + + + $.extend( DataTable.ext.classes, { + "sTable": "dataTable", + "sNoFooter": "no-footer", + + /* Paging buttons */ + "sPageButton": "paginate_button", + "sPageButtonActive": "current", + "sPageButtonDisabled": "disabled", + + /* Striping classes */ + "sStripeOdd": "odd", + "sStripeEven": "even", + + /* Empty row */ + "sRowEmpty": "dataTables_empty", + + /* Features */ + "sWrapper": "dataTables_wrapper", + "sFilter": "dataTables_filter", + "sInfo": "dataTables_info", + "sPaging": "dataTables_paginate paging_", /* Note that the type is postfixed */ + "sLength": "dataTables_length", + "sProcessing": "dataTables_processing", + + /* Sorting */ + "sSortAsc": "sorting_asc", + "sSortDesc": "sorting_desc", + "sSortable": "sorting", /* Sortable in both directions */ + "sSortableAsc": "sorting_desc_disabled", + "sSortableDesc": "sorting_asc_disabled", + "sSortableNone": "sorting_disabled", + "sSortColumn": "sorting_", /* Note that an int is postfixed for the sorting order */ + + /* Filtering */ + "sFilterInput": "", + + /* Page length */ + "sLengthSelect": "", + + /* Scrolling */ + "sScrollWrapper": "dataTables_scroll", + "sScrollHead": "dataTables_scrollHead", + "sScrollHeadInner": "dataTables_scrollHeadInner", + "sScrollBody": "dataTables_scrollBody", + "sScrollFoot": "dataTables_scrollFoot", + "sScrollFootInner": "dataTables_scrollFootInner", + + /* Misc */ + "sHeaderTH": "", + "sFooterTH": "", + + // Deprecated + "sSortJUIAsc": "", + "sSortJUIDesc": "", + "sSortJUI": "", + "sSortJUIAscAllowed": "", + "sSortJUIDescAllowed": "", + "sSortJUIWrapper": "", + "sSortIcon": "", + "sJUIHeader": "", + "sJUIFooter": "" + } ); + + + var extPagination = DataTable.ext.pager; + + function _numbers ( page, pages ) { + var + numbers = [], + buttons = extPagination.numbers_length, + half = Math.floor( buttons / 2 ), + i = 1; + + if ( pages <= buttons ) { + numbers = _range( 0, pages ); + } + else if ( page <= half ) { + numbers = _range( 0, buttons-2 ); + numbers.push( 'ellipsis' ); + numbers.push( pages-1 ); + } + else if ( page >= pages - 1 - half ) { + numbers = _range( pages-(buttons-2), pages ); + numbers.splice( 0, 0, 'ellipsis' ); // no unshift in ie6 + numbers.splice( 0, 0, 0 ); + } + else { + numbers = _range( page-half+2, page+half-1 ); + numbers.push( 'ellipsis' ); + numbers.push( pages-1 ); + numbers.splice( 0, 0, 'ellipsis' ); + numbers.splice( 0, 0, 0 ); + } + + numbers.DT_el = 'span'; + return numbers; + } + + + $.extend( extPagination, { + simple: function ( page, pages ) { + return [ 'previous', 'next' ]; + }, + + full: function ( page, pages ) { + return [ 'first', 'previous', 'next', 'last' ]; + }, + + numbers: function ( page, pages ) { + return [ _numbers(page, pages) ]; + }, + + simple_numbers: function ( page, pages ) { + return [ 'previous', _numbers(page, pages), 'next' ]; + }, + + full_numbers: function ( page, pages ) { + return [ 'first', 'previous', _numbers(page, pages), 'next', 'last' ]; + }, + + first_last_numbers: function (page, pages) { + return ['first', _numbers(page, pages), 'last']; + }, + + // For testing and plug-ins to use + _numbers: _numbers, + + // Number of number buttons (including ellipsis) to show. _Must be odd!_ + numbers_length: 7 + } ); + + + $.extend( true, DataTable.ext.renderer, { + pageButton: { + _: function ( settings, host, idx, buttons, page, pages ) { + var classes = settings.oClasses; + var lang = settings.oLanguage.oPaginate; + var aria = settings.oLanguage.oAria.paginate || {}; + var btnDisplay, btnClass, counter=0; + + var attach = function( container, buttons ) { + var i, ien, node, button, tabIndex; + var disabledClass = classes.sPageButtonDisabled; + var clickHandler = function ( e ) { + _fnPageChange( settings, e.data.action, true ); + }; + + for ( i=0, ien=buttons.length ; i<ien ; i++ ) { + button = buttons[i]; + + if ( Array.isArray( button ) ) { + var inner = $( '<'+(button.DT_el || 'div')+'/>' ) + .appendTo( container ); + attach( inner, button ); + } + else { + btnDisplay = null; + btnClass = button; + tabIndex = settings.iTabIndex; + + switch ( button ) { + case 'ellipsis': + container.append('<span class="ellipsis">…</span>'); + break; + + case 'first': + btnDisplay = lang.sFirst; + + if ( page === 0 ) { + tabIndex = -1; + btnClass += ' ' + disabledClass; + } + break; + + case 'previous': + btnDisplay = lang.sPrevious; + + if ( page === 0 ) { + tabIndex = -1; + btnClass += ' ' + disabledClass; + } + break; + + case 'next': + btnDisplay = lang.sNext; + + if ( pages === 0 || page === pages-1 ) { + tabIndex = -1; + btnClass += ' ' + disabledClass; + } + break; + + case 'last': + btnDisplay = lang.sLast; + + if ( pages === 0 || page === pages-1 ) { + tabIndex = -1; + btnClass += ' ' + disabledClass; + } + break; + + default: + btnDisplay = settings.fnFormatNumber( button + 1 ); + btnClass = page === button ? + classes.sPageButtonActive : ''; + break; + } + + if ( btnDisplay !== null ) { + node = $('<a>', { + 'class': classes.sPageButton+' '+btnClass, + 'aria-controls': settings.sTableId, + 'aria-label': aria[ button ], + 'data-dt-idx': counter, + 'tabindex': tabIndex, + 'id': idx === 0 && typeof button === 'string' ? + settings.sTableId +'_'+ button : + null + } ) + .html( btnDisplay ) + .appendTo( container ); + + _fnBindAction( + node, {action: button}, clickHandler + ); + + counter++; + } + } + } + }; + + // IE9 throws an 'unknown error' if document.activeElement is used + // inside an iframe or frame. Try / catch the error. Not good for + // accessibility, but neither are frames. + var activeEl; + + try { + // Because this approach is destroying and recreating the paging + // elements, focus is lost on the select button which is bad for + // accessibility. So we want to restore focus once the draw has + // completed + activeEl = $(host).find(document.activeElement).data('dt-idx'); + } + catch (e) {} + + attach( $(host).empty(), buttons ); + + if ( activeEl !== undefined ) { + $(host).find( '[data-dt-idx='+activeEl+']' ).trigger('focus'); + } + } + } + } ); + + + + // Built in type detection. See model.ext.aTypes for information about + // what is required from this methods. + $.extend( DataTable.ext.type.detect, [ + // Plain numbers - first since V8 detects some plain numbers as dates + // e.g. Date.parse('55') (but not all, e.g. Date.parse('22')...). + function ( d, settings ) + { + var decimal = settings.oLanguage.sDecimal; + return _isNumber( d, decimal ) ? 'num'+decimal : null; + }, + + // Dates (only those recognised by the browser's Date.parse) + function ( d, settings ) + { + // V8 tries _very_ hard to make a string passed into `Date.parse()` + // valid, so we need to use a regex to restrict date formats. Use a + // plug-in for anything other than ISO8601 style strings + if ( d && !(d instanceof Date) && ! _re_date.test(d) ) { + return null; + } + var parsed = Date.parse(d); + return (parsed !== null && !isNaN(parsed)) || _empty(d) ? 'date' : null; + }, + + // Formatted numbers + function ( d, settings ) + { + var decimal = settings.oLanguage.sDecimal; + return _isNumber( d, decimal, true ) ? 'num-fmt'+decimal : null; + }, + + // HTML numeric + function ( d, settings ) + { + var decimal = settings.oLanguage.sDecimal; + return _htmlNumeric( d, decimal ) ? 'html-num'+decimal : null; + }, + + // HTML numeric, formatted + function ( d, settings ) + { + var decimal = settings.oLanguage.sDecimal; + return _htmlNumeric( d, decimal, true ) ? 'html-num-fmt'+decimal : null; + }, + + // HTML (this is strict checking - there must be html) + function ( d, settings ) + { + return _empty( d ) || (typeof d === 'string' && d.indexOf('<') !== -1) ? + 'html' : null; + } + ] ); + + + + // Filter formatting functions. See model.ext.ofnSearch for information about + // what is required from these methods. + // + // Note that additional search methods are added for the html numbers and + // html formatted numbers by `_addNumericSort()` when we know what the decimal + // place is + + + $.extend( DataTable.ext.type.search, { + html: function ( data ) { + return _empty(data) ? + data : + typeof data === 'string' ? + data + .replace( _re_new_lines, " " ) + .replace( _re_html, "" ) : + ''; + }, + + string: function ( data ) { + return _empty(data) ? + data : + typeof data === 'string' ? + data.replace( _re_new_lines, " " ) : + data; + } + } ); + + + + var __numericReplace = function ( d, decimalPlace, re1, re2 ) { + if ( d !== 0 && (!d || d === '-') ) { + return -Infinity; + } + + // If a decimal place other than `.` is used, it needs to be given to the + // function so we can detect it and replace with a `.` which is the only + // decimal place Javascript recognises - it is not locale aware. + if ( decimalPlace ) { + d = _numToDecimal( d, decimalPlace ); + } + + if ( d.replace ) { + if ( re1 ) { + d = d.replace( re1, '' ); + } + + if ( re2 ) { + d = d.replace( re2, '' ); + } + } + + return d * 1; + }; + + + // Add the numeric 'deformatting' functions for sorting and search. This is done + // in a function to provide an easy ability for the language options to add + // additional methods if a non-period decimal place is used. + function _addNumericSort ( decimalPlace ) { + $.each( + { + // Plain numbers + "num": function ( d ) { + return __numericReplace( d, decimalPlace ); + }, + + // Formatted numbers + "num-fmt": function ( d ) { + return __numericReplace( d, decimalPlace, _re_formatted_numeric ); + }, + + // HTML numeric + "html-num": function ( d ) { + return __numericReplace( d, decimalPlace, _re_html ); + }, + + // HTML numeric, formatted + "html-num-fmt": function ( d ) { + return __numericReplace( d, decimalPlace, _re_html, _re_formatted_numeric ); + } + }, + function ( key, fn ) { + // Add the ordering method + _ext.type.order[ key+decimalPlace+'-pre' ] = fn; + + // For HTML types add a search formatter that will strip the HTML + if ( key.match(/^html\-/) ) { + _ext.type.search[ key+decimalPlace ] = _ext.type.search.html; + } + } + ); + } + + + // Default sort methods + $.extend( _ext.type.order, { + // Dates + "date-pre": function ( d ) { + var ts = Date.parse( d ); + return isNaN(ts) ? -Infinity : ts; + }, + + // html + "html-pre": function ( a ) { + return _empty(a) ? + '' : + a.replace ? + a.replace( /<.*?>/g, "" ).toLowerCase() : + a+''; + }, + + // string + "string-pre": function ( a ) { + // This is a little complex, but faster than always calling toString, + // http://jsperf.com/tostring-v-check + return _empty(a) ? + '' : + typeof a === 'string' ? + a.toLowerCase() : + ! a.toString ? + '' : + a.toString(); + }, + + // string-asc and -desc are retained only for compatibility with the old + // sort methods + "string-asc": function ( x, y ) { + return ((x < y) ? -1 : ((x > y) ? 1 : 0)); + }, + + "string-desc": function ( x, y ) { + return ((x < y) ? 1 : ((x > y) ? -1 : 0)); + } + } ); + + + // Numeric sorting types - order doesn't matter here + _addNumericSort( '' ); + + + $.extend( true, DataTable.ext.renderer, { + header: { + _: function ( settings, cell, column, classes ) { + // No additional mark-up required + // Attach a sort listener to update on sort - note that using the + // `DT` namespace will allow the event to be removed automatically + // on destroy, while the `dt` namespaced event is the one we are + // listening for + $(settings.nTable).on( 'order.dt.DT', function ( e, ctx, sorting, columns ) { + if ( settings !== ctx ) { // need to check this this is the host + return; // table, not a nested one + } + + var colIdx = column.idx; + + cell + .removeClass( + classes.sSortAsc +' '+ + classes.sSortDesc + ) + .addClass( columns[ colIdx ] == 'asc' ? + classes.sSortAsc : columns[ colIdx ] == 'desc' ? + classes.sSortDesc : + column.sSortingClass + ); + } ); + }, + + jqueryui: function ( settings, cell, column, classes ) { + $('<div/>') + .addClass( classes.sSortJUIWrapper ) + .append( cell.contents() ) + .append( $('<span/>') + .addClass( classes.sSortIcon+' '+column.sSortingClassJUI ) + ) + .appendTo( cell ); + + // Attach a sort listener to update on sort + $(settings.nTable).on( 'order.dt.DT', function ( e, ctx, sorting, columns ) { + if ( settings !== ctx ) { + return; + } + + var colIdx = column.idx; + + cell + .removeClass( classes.sSortAsc +" "+classes.sSortDesc ) + .addClass( columns[ colIdx ] == 'asc' ? + classes.sSortAsc : columns[ colIdx ] == 'desc' ? + classes.sSortDesc : + column.sSortingClass + ); + + cell + .find( 'span.'+classes.sSortIcon ) + .removeClass( + classes.sSortJUIAsc +" "+ + classes.sSortJUIDesc +" "+ + classes.sSortJUI +" "+ + classes.sSortJUIAscAllowed +" "+ + classes.sSortJUIDescAllowed + ) + .addClass( columns[ colIdx ] == 'asc' ? + classes.sSortJUIAsc : columns[ colIdx ] == 'desc' ? + classes.sSortJUIDesc : + column.sSortingClassJUI + ); + } ); + } + } + } ); + + /* + * Public helper functions. These aren't used internally by DataTables, or + * called by any of the options passed into DataTables, but they can be used + * externally by developers working with DataTables. They are helper functions + * to make working with DataTables a little bit easier. + */ + + var __htmlEscapeEntities = function ( d ) { + if (Array.isArray(d)) { + d = d.join(','); + } + + return typeof d === 'string' ? + d + .replace(/&/g, '&') + .replace(/</g, '<') + .replace(/>/g, '>') + .replace(/"/g, '"') : + d; + }; + + /** + * Helpers for `columns.render`. + * + * The options defined here can be used with the `columns.render` initialisation + * option to provide a display renderer. The following functions are defined: + * + * * `number` - Will format numeric data (defined by `columns.data`) for + * display, retaining the original unformatted data for sorting and filtering. + * It takes 5 parameters: + * * `string` - Thousands grouping separator + * * `string` - Decimal point indicator + * * `integer` - Number of decimal points to show + * * `string` (optional) - Prefix. + * * `string` (optional) - Postfix (/suffix). + * * `text` - Escape HTML to help prevent XSS attacks. It has no optional + * parameters. + * + * @example + * // Column definition using the number renderer + * { + * data: "salary", + * render: $.fn.dataTable.render.number( '\'', '.', 0, '$' ) + * } + * + * @namespace + */ + DataTable.render = { + number: function ( thousands, decimal, precision, prefix, postfix ) { + return { + display: function ( d ) { + if ( typeof d !== 'number' && typeof d !== 'string' ) { + return d; + } + + var negative = d < 0 ? '-' : ''; + var flo = parseFloat( d ); + + // If NaN then there isn't much formatting that we can do - just + // return immediately, escaping any HTML (this was supposed to + // be a number after all) + if ( isNaN( flo ) ) { + return __htmlEscapeEntities( d ); + } + + flo = flo.toFixed( precision ); + d = Math.abs( flo ); + + var intPart = parseInt( d, 10 ); + var floatPart = precision ? + decimal+(d - intPart).toFixed( precision ).substring( 2 ): + ''; + + // If zero, then can't have a negative prefix + if (intPart === 0 && parseFloat(floatPart) === 0) { + negative = ''; + } + + return negative + (prefix||'') + + intPart.toString().replace( + /\B(?=(\d{3})+(?!\d))/g, thousands + ) + + floatPart + + (postfix||''); + } + }; + }, + + text: function () { + return { + display: __htmlEscapeEntities, + filter: __htmlEscapeEntities + }; + } + }; + + + /* + * This is really a good bit rubbish this method of exposing the internal methods + * publicly... - To be fixed in 2.0 using methods on the prototype + */ + + + /** + * Create a wrapper function for exporting an internal functions to an external API. + * @param {string} fn API function name + * @returns {function} wrapped function + * @memberof DataTable#internal + */ + function _fnExternApiFunc (fn) + { + return function() { + var args = [_fnSettingsFromNode( this[DataTable.ext.iApiIndex] )].concat( + Array.prototype.slice.call(arguments) + ); + return DataTable.ext.internal[fn].apply( this, args ); + }; + } + + + /** + * Reference to internal functions for use by plug-in developers. Note that + * these methods are references to internal functions and are considered to be + * private. If you use these methods, be aware that they are liable to change + * between versions. + * @namespace + */ + $.extend( DataTable.ext.internal, { + _fnExternApiFunc: _fnExternApiFunc, + _fnBuildAjax: _fnBuildAjax, + _fnAjaxUpdate: _fnAjaxUpdate, + _fnAjaxParameters: _fnAjaxParameters, + _fnAjaxUpdateDraw: _fnAjaxUpdateDraw, + _fnAjaxDataSrc: _fnAjaxDataSrc, + _fnAddColumn: _fnAddColumn, + _fnColumnOptions: _fnColumnOptions, + _fnAdjustColumnSizing: _fnAdjustColumnSizing, + _fnVisibleToColumnIndex: _fnVisibleToColumnIndex, + _fnColumnIndexToVisible: _fnColumnIndexToVisible, + _fnVisbleColumns: _fnVisbleColumns, + _fnGetColumns: _fnGetColumns, + _fnColumnTypes: _fnColumnTypes, + _fnApplyColumnDefs: _fnApplyColumnDefs, + _fnHungarianMap: _fnHungarianMap, + _fnCamelToHungarian: _fnCamelToHungarian, + _fnLanguageCompat: _fnLanguageCompat, + _fnBrowserDetect: _fnBrowserDetect, + _fnAddData: _fnAddData, + _fnAddTr: _fnAddTr, + _fnNodeToDataIndex: _fnNodeToDataIndex, + _fnNodeToColumnIndex: _fnNodeToColumnIndex, + _fnGetCellData: _fnGetCellData, + _fnSetCellData: _fnSetCellData, + _fnSplitObjNotation: _fnSplitObjNotation, + _fnGetObjectDataFn: _fnGetObjectDataFn, + _fnSetObjectDataFn: _fnSetObjectDataFn, + _fnGetDataMaster: _fnGetDataMaster, + _fnClearTable: _fnClearTable, + _fnDeleteIndex: _fnDeleteIndex, + _fnInvalidate: _fnInvalidate, + _fnGetRowElements: _fnGetRowElements, + _fnCreateTr: _fnCreateTr, + _fnBuildHead: _fnBuildHead, + _fnDrawHead: _fnDrawHead, + _fnDraw: _fnDraw, + _fnReDraw: _fnReDraw, + _fnAddOptionsHtml: _fnAddOptionsHtml, + _fnDetectHeader: _fnDetectHeader, + _fnGetUniqueThs: _fnGetUniqueThs, + _fnFeatureHtmlFilter: _fnFeatureHtmlFilter, + _fnFilterComplete: _fnFilterComplete, + _fnFilterCustom: _fnFilterCustom, + _fnFilterColumn: _fnFilterColumn, + _fnFilter: _fnFilter, + _fnFilterCreateSearch: _fnFilterCreateSearch, + _fnEscapeRegex: _fnEscapeRegex, + _fnFilterData: _fnFilterData, + _fnFeatureHtmlInfo: _fnFeatureHtmlInfo, + _fnUpdateInfo: _fnUpdateInfo, + _fnInfoMacros: _fnInfoMacros, + _fnInitialise: _fnInitialise, + _fnInitComplete: _fnInitComplete, + _fnLengthChange: _fnLengthChange, + _fnFeatureHtmlLength: _fnFeatureHtmlLength, + _fnFeatureHtmlPaginate: _fnFeatureHtmlPaginate, + _fnPageChange: _fnPageChange, + _fnFeatureHtmlProcessing: _fnFeatureHtmlProcessing, + _fnProcessingDisplay: _fnProcessingDisplay, + _fnFeatureHtmlTable: _fnFeatureHtmlTable, + _fnScrollDraw: _fnScrollDraw, + _fnApplyToChildren: _fnApplyToChildren, + _fnCalculateColumnWidths: _fnCalculateColumnWidths, + _fnThrottle: _fnThrottle, + _fnConvertToWidth: _fnConvertToWidth, + _fnGetWidestNode: _fnGetWidestNode, + _fnGetMaxLenString: _fnGetMaxLenString, + _fnStringToCss: _fnStringToCss, + _fnSortFlatten: _fnSortFlatten, + _fnSort: _fnSort, + _fnSortAria: _fnSortAria, + _fnSortListener: _fnSortListener, + _fnSortAttachListener: _fnSortAttachListener, + _fnSortingClasses: _fnSortingClasses, + _fnSortData: _fnSortData, + _fnSaveState: _fnSaveState, + _fnLoadState: _fnLoadState, + _fnImplementState: _fnImplementState, + _fnSettingsFromNode: _fnSettingsFromNode, + _fnLog: _fnLog, + _fnMap: _fnMap, + _fnBindAction: _fnBindAction, + _fnCallbackReg: _fnCallbackReg, + _fnCallbackFire: _fnCallbackFire, + _fnLengthOverflow: _fnLengthOverflow, + _fnRenderer: _fnRenderer, + _fnDataSource: _fnDataSource, + _fnRowAttributes: _fnRowAttributes, + _fnExtend: _fnExtend, + _fnCalculateEnd: function () {} // Used by a lot of plug-ins, but redundant + // in 1.10, so this dead-end function is + // added to prevent errors + } ); + + + // jQuery access + $.fn.dataTable = DataTable; + + // Provide access to the host jQuery object (circular reference) + DataTable.$ = $; + + // Legacy aliases + $.fn.dataTableSettings = DataTable.settings; + $.fn.dataTableExt = DataTable.ext; + + // With a capital `D` we return a DataTables API instance rather than a + // jQuery object + $.fn.DataTable = function ( opts ) { + return $(this).dataTable( opts ).api(); + }; + + // All properties that are available to $.fn.dataTable should also be + // available on $.fn.DataTable + $.each( DataTable, function ( prop, val ) { + $.fn.DataTable[ prop ] = val; + } ); + + return DataTable; +})); + + +/*! DataTables styling integration + * ©2018 SpryMedia Ltd - datatables.net/license + */ + +(function( factory ){ + if ( typeof define === 'function' && define.amd ) { + // AMD + define( ['jquery', 'datatables.net'], function ( $ ) { + return factory( $, window, document ); + } ); + } + else if ( typeof exports === 'object' ) { + // CommonJS + module.exports = function (root, $) { + if ( ! root ) { + root = window; + } + + if ( ! $ || ! $.fn.dataTable ) { + // Require DataTables, which attaches to jQuery, including + // jQuery if needed and have a $ property so we can access the + // jQuery object that is used + $ = require('datatables.net')(root, $).$; + } + + return factory( $, root, root.document ); + }; + } + else { + // Browser + factory( jQuery, window, document ); + } +}(function( $, window, document, undefined ) { + +return $.fn.dataTable; + +})); + + diff --git a/docs/_static/js/tables.js b/docs/_static/js/tables.js new file mode 100644 index 00000000..6a0c4b30 --- /dev/null +++ b/docs/_static/js/tables.js @@ -0,0 +1,4 @@ +$(document).ready(function() { + $('#table-cfgcmd').DataTable(); + $('#table-opcmd').DataTable(); +} );
\ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 5501e663..29be7326 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -2,4 +2,7 @@ {%- set current_version = "1.3.x equuleus" %} {% block extrahead %} <link href="{{ pathto("_static/css/custom.css", True) }}" rel="stylesheet" type="text/css"> + <link href="{{ pathto("_static/css/datatables.css", True) }}" rel="stylesheet" type="text/css"> + <script type="text/javascript" charset="utf8" src="{{ pathto("_static/js/datatables.js", True) }}"></script> + <script type="text/javascript" charset="utf8" src="{{ pathto("_static/js/tables.js", True) }}"></script> {% endblock %} diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index 1f9108f8..8859f109 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -45,6 +45,33 @@ prepended with ``run``, even if you haven't created a session with configure. run show interfaces exit +Run commands remotely +--------------------- + +Sometimes you simply wan't to execute a bunch of op-mode commands via SSH on +a remote VyOS system. + +.. code-block:: none + + ssh 192.0.2.1 'vbash -s' <<EOF + source /opt/vyatta/etc/functions/script-template + run show interfaces + exit + EOF + +Will return: + +.. code-block:: none + + Welcome to VyOS + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 192.0.2.1/24 u/u + lo 127.0.0.1/8 u/u + ::1/128 + + Other script languages ---------------------- @@ -115,20 +142,20 @@ The default directories where your custom Scripts should be located are: .. code-block:: none - /config/scripts/commit/pre-hooks.d - Directory with scripts that run before + /config/scripts/commit/pre-hooks.d - Directory with scripts that run before each commit. /config/scripts/commit/post-hooks.d - Directory with scripts that run after each commit. -Scripts are run in alphabetical order. Their names must consist entirely of -ASCII upper- and lower-case letters,ASCII digits, ASCII underscores, and +Scripts are run in alphabetical order. Their names must consist entirely of +ASCII upper- and lower-case letters,ASCII digits, ASCII underscores, and ASCII minus-hyphens.No other characters are allowed. .. note:: Custom scripts are not executed with root privileges (Use sudo inside if this is necessary). -A simple example is shown below, where the ops command executed in +A simple example is shown below, where the ops command executed in the post-hook script is "show interfaces". .. code-block:: none @@ -143,7 +170,7 @@ the post-hook script is "show interfaces". eth2 - u/u eth3 - u/u lo 203.0.113.5/24 u/u - + Preconfig on boot ----------------- @@ -158,9 +185,9 @@ The default file looks like this: .. code-block:: none #!/bin/sh - # This script is executed at boot time before VyOS configuration is applied. + # This script is executed at boot time before VyOS configuration is applied. # Any modifications required to work around unfixed bugs or use - # services not available through the VyOS CLI system can be placed here. + # services not available through the VyOS CLI system can be placed here. Postconfig on boot diff --git a/docs/changelog/1.3.rst b/docs/changelog/1.3.rst index 058f38d6..38adb0d2 100644 --- a/docs/changelog/1.3.rst +++ b/docs/changelog/1.3.rst @@ -8,13 +8,432 @@ _ext/releasenotes.py +2022-04-19 +========== + +* :vytask:`T4344` (bug): DHCP statistics not matching, conf-mode generates incorrect pool name with dash +* :vytask:`T4268` (bug): Elevated LA while using VyOS monitoring feature + + +2022-04-08 +========== + +* :vytask:`T4331` (bug): IPv6 link local addresses are not configured when an interface is in a VRF +* :vytask:`T4339` (bug): wwan: tab-completion results in "No such file or directory" if there is no WWAN interface +* :vytask:`T4338` (bug): wwan: changing interface description should not trigger reconnect +* :vytask:`T4324` (bug): wwan: check alive script should only be run via cron if a wwan interface is configured at all + + +2022-04-07 +========== + +* :vytask:`T4330` (bug): MTU settings cannot be applied when IPv6 is disabled +* :vytask:`T4346` (feature): Deprecate "system ipv6 disable" option to disable address family within OS kernel +* :vytask:`T4337` (bug): isis: IETF SPF delay algorithm can not be configured - results in vyos.frr.CommitError +* :vytask:`T4319` (bug): The command "set system ipv6 disable" doesn't work as expected. +* :vytask:`T4341` (feature): login: disable user-account prior to deletion and wait until deletion is complete +* :vytask:`T4336` (feature): isis: add support for MD5 authentication password on a circuit + + +2022-04-06 +========== + +* :vytask:`T4308` (feature): Op-comm "Show log frr" to view specific protocol logs + + +2022-03-29 +========== + +* :vytask:`T3686` (bug): Bridging OpenVPN tap with no local-address breaks + + +2022-03-24 +========== + +* :vytask:`T4294` (bug): Adding a new openvpn-option does not restart the OpenVPN process +* :vytask:`T4230` (bug): OpenVPN server configuration deleted after reboot when using a VRRP virtual-address + + +2022-03-21 +========== + +* :vytask:`T4311` (bug): CVE-2021-4034: local privilege escalation in PolKit +* :vytask:`T4310` (bug): CVE-2022-0778: infinite loop in OpenSSL certificate parsing + + +2022-03-12 +========== + +* :vytask:`T4296` (bug): Interface config injected by Cloud-Init may interfere with VyOS native +* :vytask:`T4002` (default): firewall group network-group long names restriction incorrect behavior + + +2022-03-11 +========== + +* :vytask:`T4297` (bug): Interface configuration saving fails for ice/iavf based interfaces because they can't change speed/duplex settings + + +2022-03-05 +========== + +* :vytask:`T4259` (bug): The conntrackd daemon can be started wrongly + + +2022-02-28 +========== + +* :vytask:`T4273` (bug): ssh: Upgrade from 1.2.X to 1.3.0 breaks config +* :vytask:`T4115` (bug): reboot in <x> not working as expected + + +2022-02-24 +========== + +* :vytask:`T4267` (bug): Error - Missing required "ip key" parameter + + +2022-02-23 +========== + +* :vytask:`T4264` (bug): vxlan: interface is destroyed and rebuild on description change +* :vytask:`T4263` (bug): vyos.util.leaf_node_changed() dos not honor valueLess nodes + + +2022-02-21 +========== + +* :vytask:`T4120` (feature): [VXLAN] add ability to set multiple unicast-remotes + + +2022-02-20 +========== + +* :vytask:`T4261` (feature): MACsec: add DHCP client support +* :vytask:`T4203` (bug): Reconfigure DHCP client interface causes brief outages + + +2022-02-19 +========== + +* :vytask:`T4258` (bug): [DHCP-SERVER] error parameter on Failover + + +2022-02-17 +========== + +* :vytask:`T4241` (bug): ocserv openconnect looks broken in recent bulds of 1.3 Equuleus +* :vytask:`T4255` (bug): Unexpected print of dict bridge on delete +* :vytask:`T4240` (bug): Cannot add wlan0 to bridge via configure +* :vytask:`T4154` (bug): Error add second gre tunnel with the same source interface + + +2022-02-16 +========== + +* :vytask:`T4237` (bug): Conntrack-sync error - error adding listen-address command + + +2022-02-15 +========== + +* :vytask:`T4201` (bug): Firewall - ICMPv6 matches not working as expected on 1.3.0 +* :vytask:`T3006` (bug): Accel-PPP & vlan-mon config get invalid VLAN +* :vytask:`T3494` (bug): DHCPv6 leases traceback when PD using + + +2022-02-13 +========== + +* :vytask:`T4242` (bug): ethernet speed/duplex can never be switched back to auto/auto +* :vytask:`T4191` (bug): Lost access to host after VRF re-creating + + +2022-02-11 +========== + +* :vytask:`T3872` (feature): Add configurable telegraf monitoring service +* :vytask:`T4234` (bug): Show firewall partly broken in 1.3.x + + +2022-02-10 +========== + +* :vytask:`T4165` (bug): Custom conntrack rules cannot be deleted + + +2022-02-08 +========== + +* :vytask:`T4227` (bug): Typo in help completion of hello-time option of bridge interface + + +2022-02-07 +========== + +* :vytask:`T4233` (bug): ssh: sync regex for allow/deny usernames to "system login" +* :vytask:`T4087` (feature): IPsec IKE-group proposals limit of 10 pieces + + +2022-02-06 +========== + +* :vytask:`T4228` (bug): bond: OS error thrown when two bonds use the same member + + +2022-02-05 +========== + +* :vytask:`T4226` (bug): VRRP transition-script does not work for groups name which contains -(minus) sign + + +2022-02-04 +========== + +* :vytask:`T4196` (bug): DHCP server client-prefix-length parameter results in non-functional leases + + +2022-02-03 +========== + +* :vytask:`T3643` (bug): show vpn ipsec sa doesn't show tunnels in "down" state + + +2022-02-01 +========== + +* :vytask:`T4198` (bug): Error shown on commit + + +2022-01-29 +========== + +* :vytask:`T4153` (bug): Monitor bandwidth-test initiate not working + + +2022-01-28 +========== + +* :vytask:`T4184` (bug): NTP allow-clients address doesn't work it allows to use ntp server for all addresses + + +2022-01-24 +========== + +* :vytask:`T4204` (feature): Update Accel-PPP to a newer revision + + +2022-01-17 +========== + +* :vytask:`T3164` (bug): console-server ssh does not work with RADIUS PAM auth + + +2022-01-15 +========== + +* :vytask:`T4183` (feature): IPv6 link-local address not accepted as wireguard peer +* :vytask:`T4110` (feature): [IPV6-SSH/DNS} enable IPv6 link local adresses as listen-address %eth0 + + +2022-01-12 +========== + +* :vytask:`T4168` (bug): IPsec VPN is impossible to restart when DMVPN is configured +* :vytask:`T4167` (bug): DMVPN apply wrong param on the first configuration +* :vytask:`T4152` (bug): NHRP shortcut-target holding-time does not work + + +2022-01-10 +========== + +* :vytask:`T3299` (bug): Allow the web proxy service to listen on all IP addresses +* :vytask:`T3115` (feature): Add support for firewall on L3 VIF bridge interface + + +2022-01-09 +========== + +* :vytask:`T3822` (bug): OpenVPN processes do not have permission to read key files generated with `run generate openvpn key` +* :vytask:`T4142` (bug): Input ifbX interfaces not displayed in op-mode +* :vytask:`T3914` (bug): VRRP rfc3768-compatibility doesn't work with unicast peers + + +2022-01-07 +========== + +* :vytask:`T3924` (bug): VRRP stops working with VRF + + +2022-01-06 +========== + +* :vytask:`T4141` (bug): Set high-availability vrrp sync-group without members error + + +2022-01-03 +========== + +* :vytask:`T4065` (bug): IPSEC configuration error: connection to unix:///var/run/charon.ctl failed: No such file or directory +* :vytask:`T4052` (bug): Validator return traceback on VRRP configuration with the script path not in config dir +* :vytask:`T4128` (bug): keepalived: Upgrade package to add VRF support + + +2021-12-31 +========== + +* :vytask:`T4081` (bug): VRRP health-check script stops working when setting up a sync group + + +2021-12-29 +========== + +* :vytask:`T2922` (bug): The `vpn ipsec logging log-modes` miss the IPSec daemons state check +* :vytask:`T2695` (bug): Flow-accounting bug with subinterfaces +* :vytask:`T2400` (default): OpenVPN: dont restart server if no need +* :vytask:`T4086` (default): system login banner is not removed on deletion. + + +2021-12-28 +========== + +* :vytask:`T3380` (bug): Show vpn ike sa with IPv6 remote peer +* :vytask:`T2933` (feature): VRRP add option virtual_ipaddress_excluded + + +2021-12-27 +========== + +* :vytask:`T2566` (bug): sstp not able to run tunnels ipv6 only +* :vytask:`T4093` (bug): SNMPv3 snmpd.conf generation bug +* :vytask:`T2764` (enhancment): Increase maximum number of NAT rules + + +2021-12-26 +========== + +* :vytask:`T4104` (bug): RAID1: "add raid md0 member sda1" does not restore boot sector + + +2021-12-25 +========== + +* :vytask:`T4101` (bug): commit-archive: Use of uninitialized value $source_address in concatenation +* :vytask:`T4055` (feature): Add VRF support for HTTP(S) API service + + +2021-12-24 +========== + +* :vytask:`T3854` (bug): Missing op-mode commands for conntrack-sync + + +2021-12-23 +========== + +* :vytask:`T4092` (bug): IKEv2 mobike commit failed with DMVPN nhrp +* :vytask:`T3354` (default): Convert strip-private script from Perl to Python + + +2021-12-22 +========== + +* :vytask:`T3356` (feature): Script for remote file transfers + + +2021-12-21 +========== + +* :vytask:`T4053` (bug): VRRP impossible to set scripts out of the /config directory +* :vytask:`T4013` (bug): Add pkg cloudwatch for AWS images +* :vytask:`T3913` (bug): VRF traffic fails after upgrade from 1.3.0-RC6 to 1.3.0-EPA1/2 + + +2021-12-20 +========== + +* :vytask:`T4088` (default): Fix typo in login banner + + +2021-12-19 +========== + +* :vytask:`T3912` (default): Use a more informative default post-login banner + + +2021-12-17 +========== + +* :vytask:`T3176` (bug): Ordering of ports on EdgeCore SAF51015I is mixed up? +* :vytask:`T4059` (bug): VRRP sync-group transition script does not persist after reboot + + +2021-12-16 +========== + +* :vytask:`T4046` (feature): Sflow - Add Source address parameter +* :vytask:`T2615` (default): Provide an explicit option for server fingerprint in commit archive, and make insecure the default +* :vytask:`T4076` (enhancment): Allow setting CORS options in HTTP API +* :vytask:`T3378` (bug): commit-archive source-address broken for IPv6 addresses + + +2021-12-15 +========== + +* :vytask:`T4077` (bug): op-mode: bfd: drop "show protocols bfd" in favour of "show bfd" +* :vytask:`T4073` (bug): "show protocols bfd peer <>" shows incorrect peer information. + + +2021-12-14 +========== + +* :vytask:`T4071` (feature): Allow HTTP API to bind to unix domain socket + + +2021-12-12 +========== + +* :vytask:`T4036` (bug): VXLAN incorrect raiseError if set multicast network instead of singe address + + +2021-12-10 +========== + +* :vytask:`T4068` (feature): Python: ConfigError should insert line breaks into the error message + + +2021-12-09 +========== + +* :vytask:`T4033` (bug): VRRP - Error security when setting scripts +* :vytask:`T4064` (bug): IP address for vif is not removed from the system when deleted in configuration +* :vytask:`T4063` (bug): VRRP log error - /usr/libexec/vyos/vyos-vrrp-conntracksync.sh - No such file or directory +* :vytask:`T4060` (enhancment): Extend configquery for use before boot configuration is complete + + +2021-12-08 +========== + +* :vytask:`T4024` (bug): Access-lists and prefix-lists disappear when setting ldp hello-ipv4-interval + + +2021-12-07 +========== + +* :vytask:`T4041` (servicerequest): "transition-script" doesn't work on "sync-group" + + +2021-12-06 +========== + +* :vytask:`T4012` (feature): Add VRF support for TFTP + + 2021-12-05 ========== * :vytask:`T4034` (bug): "make xcp-ng-iso" still includes vyos-xe-guest-utilities * :vytask:`T2076` (feature): RAID install: sfdisk change-id is deprecated in favor of --part-type -* :vytask:`T4041` (bug): "transition-script" doesn't work on "sync-group" -* :vytask:`T1869` (bug): Install and Boot from RAID Doesn't Work * :vytask:`T1126` (bug): Reusing a RAID from a BIOS install in an EFI install causes a failure to boot @@ -261,7 +680,6 @@ * :vytask:`T3254` (bug): Dynamic DNS status shows incorrect last update time * :vytask:`T3253` (bug): rpki: multiple peers cannot be configured * :vytask:`T3219` (default): Typo in openvpn server client config for IPv6 iroute -* :vytask:`T2764` (enhancment): Increase maximum number of NAT rules * :vytask:`T2100` (feature): BGP route adverisement wih checks rib * :vytask:`T1663` (enhancment): T1656 equuleus: buster: arm64/aarch64: ipaddrcheck does not complete testing * :vytask:`T1243` (bug): BGP local-as accept wrong values @@ -1215,7 +1633,7 @@ 2021-02-16 ========== -* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.163 / 5.10.83 +* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.188 / 5.10.111 2021-02-14 diff --git a/docs/conf.py b/docs/conf.py index 3d011ad5..661ff06d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,6 +45,8 @@ extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', 'notfound.extension', + 'myst_parser', + 'sphinx_panels', 'vyos' ] diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.log b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.log new file mode 100644 index 00000000..8956520e --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.log @@ -0,0 +1,765 @@ +2022-03-22 21:20:55,453 p=84842 u=rob n=ansible | PLAY [prepare node and Lab] ******************************************************************************************************************************************************************************** +2022-03-22 21:20:55,471 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : fail] *************************************************************************************************************************************************************************** +2022-03-22 21:20:55,485 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:55,490 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:55,497 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:55,498 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:55,501 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:55,503 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : fail] *************************************************************************************************************************************************************************** +2022-03-22 21:20:55,515 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:55,521 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:55,526 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:55,528 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:55,531 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:55,535 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************************************************************************************* +2022-03-22 21:20:55,560 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:55,567 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:55,567 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:55,571 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:56,450 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:20:56,455 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : get template facts] ************************************************************************************************************************************************************* +2022-03-22 21:20:56,483 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:56,491 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:56,492 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:56,496 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:56,933 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:20:56,938 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Register path status] *********************************************************************************************************************************************************** +2022-03-22 21:20:56,964 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:56,973 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:56,975 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:56,979 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,305 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:20:57,307 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : create path] ******************************************************************************************************************************************************************** +2022-03-22 21:20:57,321 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,328 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,335 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,337 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,341 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,344 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Download iso] ******************************************************************************************************************************************************************* +2022-03-22 21:20:57,358 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,363 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,370 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,372 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,376 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,378 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : create virtioa.qcow2 file] ****************************************************************************************************************************************************** +2022-03-22 21:20:57,393 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,399 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,405 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,406 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,410 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,412 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************************************************************************************* +2022-03-22 21:20:57,424 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,430 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,436 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,438 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,441 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,443 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : create lab for node install] **************************************************************************************************************************************************** +2022-03-22 21:20:57,454 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,461 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,466 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,468 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,471 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,473 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : open lab] *********************************************************************************************************************************************************************** +2022-03-22 21:20:57,484 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,489 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,496 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,498 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,501 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,504 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] *********************************************************************************************************************************************************************** +2022-03-22 21:20:57,516 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,521 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,527 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,529 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,531 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,533 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : add node to lab] **************************************************************************************************************************************************************** +2022-03-22 21:20:57,547 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,553 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,559 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,561 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,563 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,565 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : start node] ********************************************************************************************************************************************************************* +2022-03-22 21:20:57,578 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,584 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,590 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,592 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,594 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,597 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : get node infos] ***************************************************************************************************************************************************************** +2022-03-22 21:20:57,613 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,619 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,625 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,627 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,630 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,632 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] *********************************************************************************************************************************************************************** +2022-03-22 21:20:57,646 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,653 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,660 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,662 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,665 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,668 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : copy file] ********************************************************************************************************************************************************************** +2022-03-22 21:20:57,681 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,687 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,694 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,696 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,699 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,701 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : run expect script] ************************************************************************************************************************************************************** +2022-03-22 21:20:57,714 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,721 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,727 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,729 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,733 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,735 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie (due timeout)] *********************************************************************************************************************************** +2022-03-22 21:20:57,749 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,757 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,763 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,765 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,770 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,773 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : stop node] ********************************************************************************************************************************************************************** +2022-03-22 21:20:57,792 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,801 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,809 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,810 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,815 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,819 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : Pause to wait node is shutdown] ************************************************************************************************************************************************* +2022-03-22 21:20:57,830 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,833 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : delete iso] ********************************************************************************************************************************************************************* +2022-03-22 21:20:57,849 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,857 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,866 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,867 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,871 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,874 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : commit virtioa.qcow2] *********************************************************************************************************************************************************** +2022-03-22 21:20:57,889 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,896 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,901 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,903 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,906 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,908 p=84842 u=rob n=ansible | TASK [eve-ng-create-node : delete lab for node install] **************************************************************************************************************************************************** +2022-03-22 21:20:57,922 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:57,927 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:57,933 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:57,935 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:57,938 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:57,946 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Get env file content] ************************************************************************************************************************************************************** +2022-03-22 21:20:58,233 p=84842 u=rob n=ansible | ok: [transport -> localhost] +2022-03-22 21:20:58,235 p=84842 u=rob n=ansible | ok: [vyos-oobm -> localhost] +2022-03-22 21:20:58,238 p=84842 u=rob n=ansible | ok: [dhcp-server -> localhost] +2022-03-22 21:20:58,239 p=84842 u=rob n=ansible | ok: [dhcp-relay -> localhost] +2022-03-22 21:20:58,243 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:20:58,245 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Load facts] ************************************************************************************************************************************************************************ +2022-03-22 21:20:58,272 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:20:58,273 p=84842 u=rob n=ansible | ok: [vyos-oobm] +2022-03-22 21:20:59,175 p=85144 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:20:59,178 p=85143 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:20:59,180 p=85145 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:20:59,185 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:20:59,187 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:20:59,189 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:20:59,197 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ****************************************************************************************************************************************************************************** +2022-03-22 21:20:59,221 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:20:59,229 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:59,239 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:59,241 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:59,246 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:59,249 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:20:59,270 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:59,276 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:59,278 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:59,281 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:20:59,912 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:20:59,917 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : get running lab list] ************************************************************************************************************************************************************** +2022-03-22 21:20:59,944 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:20:59,953 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:20:59,954 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:20:59,958 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:00,406 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:00,411 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : delete existing lab] *************************************************************************************************************************************************************** +2022-03-22 21:21:00,434 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:00,442 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:00,443 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:00,448 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:01,022 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:01,028 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Ensure labtest is present] ********************************************************************************************************************************************************* +2022-03-22 21:21:01,054 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:01,061 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:01,063 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:01,068 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:01,379 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:01,384 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Create DHCPRelay_through_GRE Lab] ************************************************************************************************************************************************** +2022-03-22 21:21:01,404 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:01,410 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:01,412 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:01,415 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:02,058 p=84842 u=rob n=ansible | changed: [eveng] +2022-03-22 21:21:02,062 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:21:02,084 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:02,091 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:02,093 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:02,097 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:02,704 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:02,708 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : start vyos-oobm] ******************************************************************************************************************************************************************* +2022-03-22 21:21:02,731 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:02,737 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:02,739 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:02,743 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:03,697 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:03,704 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos-oobm] **************************************************************************************************************************************************************** +2022-03-22 21:21:03,724 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:21:03,738 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:03,740 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:03,744 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:55,097 p=84842 u=rob n=ansible | ok: [vyos-oobm] +2022-03-22 21:21:55,103 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:21:55,130 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:55,138 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:55,140 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:55,144 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:55,865 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:55,870 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : get lab status] ******************************************************************************************************************************************************************** +2022-03-22 21:21:55,897 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:55,905 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:55,907 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:55,911 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:56,367 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:21:56,372 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : start all nodes] ******************************************************************************************************************************************************************* +2022-03-22 21:21:56,400 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:21:56,407 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:21:56,410 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:21:56,415 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:21:57,320 p=84842 u=rob n=ansible | ok: [eveng] => (item=2) +2022-03-22 21:21:58,357 p=84842 u=rob n=ansible | ok: [eveng] => (item=3) +2022-03-22 21:21:59,421 p=84842 u=rob n=ansible | ok: [eveng] => (item=4) +2022-03-22 21:22:00,131 p=84842 u=rob n=ansible | ok: [eveng] => (item=1) +2022-03-22 21:22:01,065 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:22:01,071 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:22:01,091 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:22:01,099 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:22:16,994 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:16,997 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:16,997 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:16,997 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:16,997 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf += self._read_timeout(timeout) +2022-03-22 21:22:16,998 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:16,998 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:16,998 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise socket.timeout() +2022-03-22 21:22:16,998 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:16,998 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | socket.timeout +2022-03-22 21:22:16,998 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:16,998 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:16,998 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:16,998 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf += self._read_timeout(timeout) +2022-03-22 21:22:16,998 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf += self._read_timeout(timeout) +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise socket.timeout() +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise socket.timeout() +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | socket.timeout +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | socket.timeout +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | self._check_banner() +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise SSHException( +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:16,999 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:16,999 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:16,999 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:17,000 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:17,000 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | self._check_banner() +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | self._check_banner() +2022-03-22 21:22:17,000 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:17,000 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise SSHException( +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise SSHException( +2022-03-22 21:22:17,000 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:17,000 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:17,000 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:33,031 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:33,032 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:33,032 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:33,032 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:33,032 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf += self._read_timeout(timeout) +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise socket.timeout() +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | socket.timeout +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:33,033 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | self._check_banner() +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise SSHException( +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:33,034 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:33,034 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf += self._read_timeout(timeout) +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise socket.timeout() +2022-03-22 21:22:33,035 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | socket.timeout +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | self._check_banner() +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise SSHException( +2022-03-22 21:22:33,036 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:33,037 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:33,041 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf += self._read_timeout(timeout) +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:33,042 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise socket.timeout() +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | socket.timeout +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | self._check_banner() +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:33,043 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise SSHException( +2022-03-22 21:22:33,044 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:33,044 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:49,065 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:49,065 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:49,065 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | buf += self._read_timeout(timeout) +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise socket.timeout() +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | socket.timeout +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:49,066 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Traceback (most recent call last): +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | self._check_banner() +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | raise SSHException( +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:49,067 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | +2022-03-22 21:22:49,071 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | buf += self._read_timeout(timeout) +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise socket.timeout() +2022-03-22 21:22:49,072 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | socket.timeout +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Traceback (most recent call last): +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | self._check_banner() +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:49,073 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | raise SSHException( +2022-03-22 21:22:49,074 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:49,074 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | +2022-03-22 21:22:49,083 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Exception: Error reading SSH protocol banner +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf = self.packetizer.readline(timeout) +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | buf += self._read_timeout(timeout) +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise socket.timeout() +2022-03-22 21:22:49,084 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | socket.timeout +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | During handling of the above exception, another exception occurred: +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Traceback (most recent call last): +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | self._check_banner() +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | raise SSHException( +2022-03-22 21:22:49,085 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:22:49,086 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | +2022-03-22 21:22:50,708 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:50,728 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:50,728 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:50,794 p=85493 u=rob n=p=85493 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:22:50,796 p=85494 u=rob n=p=85494 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:22:50,802 p=85495 u=rob n=p=85495 u=rob | paramiko [transport] | Authentication (publickey) successful! +2022-03-22 21:22:51,760 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:22:51,760 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:22:51,760 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:22:51,763 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : include DHCPRelay_through_GRE lab_config.yml] ************************************************************************************************************************************** +2022-03-22 21:22:51,776 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:22:51,781 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:22:51,799 p=84842 u=rob n=ansible | included: /Users/rob/git/_vyos/vyos-eveng/labs/DHCPRelay_through_GRE/lab_config.yml for dhcp-relay, dhcp-server, transport +2022-03-22 21:22:51,830 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : setup nodes] *********************************************************************************************************************************************************************** +2022-03-22 21:22:53,477 p=85155 u=rob n=p=85155 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:53,510 p=85157 u=rob n=p=85157 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:53,514 p=85156 u=rob n=p=85156 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:22:53,557 p=85155 u=rob n=p=85155 u=rob | paramiko [transport] | Authentication (publickey) successful! +2022-03-22 21:22:53,578 p=85157 u=rob n=p=85157 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:22:53,579 p=85156 u=rob n=p=85156 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:22:57,928 p=84842 u=rob n=ansible | [WARNING]: To ensure idempotency and correct diff the input configuration lines should be similar to how they appear if present in the running configuration on device including the indentation + +2022-03-22 21:22:57,928 p=84842 u=rob n=ansible | changed: [transport] +2022-03-22 21:23:00,514 p=84842 u=rob n=ansible | changed: [dhcp-relay] +2022-03-22 21:23:01,097 p=84842 u=rob n=ansible | changed: [dhcp-server] +2022-03-22 21:23:01,101 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:23:01,125 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:23:01,132 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:23:01,133 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:23:01,138 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:23:01,944 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:23:01,950 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:23:02,939 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:23:02,945 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:23:02,959 p=85674 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:23:02,960 p=85674 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:23:07,966 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:23:07,973 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:23:08,771 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:23:08,778 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:23:08,793 p=85694 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:23:08,793 p=85694 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:23:13,803 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:23:13,810 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:23:13,824 p=85696 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:23:13,825 p=85696 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:23:43,836 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:23:43,847 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:23:43,884 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:23:43,892 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:23:43,902 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:23:49,241 p=84842 u=rob n=ansible | ok: [dhcp-relay] => (item=172.16.0.1) +2022-03-22 21:23:49,243 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=172.16.0.2) +2022-03-22 21:23:53,584 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=192.168.0.30) +2022-03-22 21:23:53,588 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:23:53,611 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:23:53,618 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:23:53,618 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:23:53,620 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:23:53,626 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:23:53,628 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:23:53,646 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:23:53,652 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:23:53,653 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:23:53,660 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:23:55,086 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item={'name': 'show_dhcp_server_leases', 'command': 'show dhcp server leases'}) +2022-03-22 21:23:58,434 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item={'name': 'ping_client', 'command': 'ping 192.168.0.30 count 4'}) +2022-03-22 21:23:58,439 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:23:58,461 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:23:58,467 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:23:58,468 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:23:58,475 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:23:59,310 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:23:59,320 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] *********************************************************************************************************************************************************************** +2022-03-22 21:23:59,347 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:23:59,356 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:24:00,621 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:24:00,655 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:24:00,656 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:24:00,658 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] *************************************************************************************************************************************************************** +2022-03-22 21:24:00,666 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:24:00,668 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:24:00,680 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:24:00,686 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:24:02,297 p=85882 u=rob n=p=85882 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:24:02,303 p=85883 u=rob n=p=85883 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:24:02,306 p=85884 u=rob n=p=85884 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:24:02,377 p=85882 u=rob n=p=85882 u=rob | paramiko [dhcp-relay] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:24:02,377 p=85884 u=rob n=p=85884 u=rob | paramiko [transport] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:24:02,378 p=85883 u=rob n=p=85883 u=rob | paramiko [dhcp-server] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:26:00,903 p=85156 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:26:00,908 p=85157 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:26:00,913 p=85155 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:26:01,008 p=85156 u=rob n=ansible | shutdown complete +2022-03-22 21:26:01,011 p=85157 u=rob n=ansible | shutdown complete +2022-03-22 21:26:01,017 p=85155 u=rob n=ansible | shutdown complete +2022-03-22 21:26:04,155 p=85883 u=rob n=p=85883 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:26:04,155 p=85882 u=rob n=p=85882 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:26:04,156 p=85884 u=rob n=p=85884 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:26:04,237 p=85883 u=rob n=p=85883 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:26:04,238 p=85882 u=rob n=p=85882 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:26:04,254 p=85884 u=rob n=p=85884 u=rob | paramiko [transport] | Authentication (publickey) successful! +2022-03-22 21:26:05,443 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:26:05,472 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:26:05,481 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:26:05,483 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:26:05,501 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:26:05,506 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:26:05,508 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:26:05,511 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:26:06,347 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:26:06,353 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:26:07,274 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:26:07,283 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:26:07,299 p=86005 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:26:07,300 p=86005 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:26:12,310 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:26:12,322 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:26:13,097 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:26:13,105 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:26:13,122 p=86026 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:26:13,122 p=86026 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:26:18,128 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:26:18,138 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:26:18,156 p=86027 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:26:18,156 p=86027 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:26:48,164 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:26:48,177 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:26:48,215 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:26:48,222 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:26:48,233 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:26:49,093 p=86035 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:26:49,093 p=86034 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:26:49,610 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:26:49,626 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:26:49,702 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:26:49,712 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:26:55,418 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=172.16.0.2) +2022-03-22 21:26:55,433 p=84842 u=rob n=ansible | ok: [dhcp-relay] => (item=172.16.0.1) +2022-03-22 21:27:00,611 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=192.168.0.30) +2022-03-22 21:27:00,616 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:27:00,640 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:00,647 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:00,648 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:00,650 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:27:00,655 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:00,657 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:27:00,676 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:00,682 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:00,683 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:00,689 p=84842 u=rob n=ansible | skipping: [dhcp-server] => (item={'name': 'show_dhcp_server_leases', 'command': 'show dhcp server leases'}) +2022-03-22 21:27:00,690 p=84842 u=rob n=ansible | skipping: [dhcp-server] => (item={'name': 'ping_client', 'command': 'ping 192.168.0.30 count 4'}) +2022-03-22 21:27:00,691 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:00,693 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:27:00,712 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:00,718 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:00,718 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:00,720 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:27:00,725 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:00,728 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : make sure tmp dir exist] *********************************************************************************************************************************************************** +2022-03-22 21:27:00,750 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:00,758 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:00,759 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:27:00,763 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:00,914 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:27:00,917 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : register status of tmp/vyos-1.4-rolling-202203220701-amd64.iso] ******************************************************************************************************************** +2022-03-22 21:27:00,935 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:00,942 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:00,943 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:27:00,947 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:01,193 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:27:01,199 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Download upgrade_iso] ************************************************************************************************************************************************************** +2022-03-22 21:27:01,227 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:01,234 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:27:01,236 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:27:01,241 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:27:02,049 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:27:02,055 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Copy iso to host] ****************************************************************************************************************************************************************** +2022-03-22 21:27:02,071 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:02,077 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:02,987 p=86187 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:27:03,436 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:03,458 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:03,487 p=86193 u=rob n=paramiko.transport | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:03,535 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:27:03,537 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:27:03,552 p=86193 u=rob n=paramiko.transport | Authentication (publickey) successful! +2022-03-22 21:27:04,240 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:04,274 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:04,304 p=86193 u=rob n=paramiko.transport | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:04,337 p=86044 u=rob n=p=86044 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:27:04,348 p=86043 u=rob n=p=86043 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:27:04,362 p=86193 u=rob n=paramiko.transport | Authentication (publickey) successful! +2022-03-22 21:27:43,217 p=84842 u=rob n=ansible | changed: [dhcp-relay] +2022-03-22 21:27:43,272 p=84842 u=rob n=ansible | changed: [dhcp-server] +2022-03-22 21:27:43,298 p=84842 u=rob n=ansible | changed: [transport] +2022-03-22 21:27:43,305 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : upgrade vyos] ********************************************************************************************************************************************************************** +2022-03-22 21:27:43,325 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:43,333 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:45,034 p=86193 u=rob n=p=86193 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:27:45,173 p=86193 u=rob n=p=86193 u=rob | paramiko [transport] | Authentication (publickey) successful! +2022-03-22 21:27:55,635 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:27:55,635 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:27:58,055 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:27:58,059 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] *********************************************************************************************************************************************************************** +2022-03-22 21:27:58,076 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:58,083 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:27:59,607 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:27:59,610 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:27:59,610 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:27:59,613 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] *************************************************************************************************************************************************************** +2022-03-22 21:27:59,624 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:59,627 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:27:59,641 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:27:59,647 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:28:01,368 p=86331 u=rob n=p=86331 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:28:01,368 p=86330 u=rob n=p=86330 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:28:01,382 p=86329 u=rob n=p=86329 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:28:01,478 p=86331 u=rob n=p=86331 u=rob | paramiko [transport] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:28:01,482 p=86330 u=rob n=p=86330 u=rob | paramiko [dhcp-server] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:28:01,496 p=86329 u=rob n=p=86329 u=rob | paramiko [dhcp-relay] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:29:59,865 p=86044 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:29:59,874 p=86193 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:29:59,868 p=86043 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:29:59,983 p=86193 u=rob n=ansible | shutdown complete +2022-03-22 21:29:59,983 p=86044 u=rob n=ansible | shutdown complete +2022-03-22 21:29:59,984 p=86043 u=rob n=ansible | shutdown complete +2022-03-22 21:30:03,162 p=86331 u=rob n=p=86331 u=rob | paramiko [transport] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:30:03,170 p=86330 u=rob n=p=86330 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:30:03,170 p=86329 u=rob n=p=86329 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:30:03,237 p=86330 u=rob n=p=86330 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:30:03,237 p=86329 u=rob n=p=86329 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:30:03,246 p=86331 u=rob n=p=86331 u=rob | paramiko [transport] | Authentication (publickey) successful! +2022-03-22 21:30:04,670 p=84842 u=rob n=ansible | ok: [dhcp-relay] +2022-03-22 21:30:04,676 p=84842 u=rob n=ansible | ok: [transport] +2022-03-22 21:30:04,722 p=84842 u=rob n=ansible | ok: [dhcp-server] +2022-03-22 21:30:04,724 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : clear tmp dir] ********************************************************************************************************************************************************************* +2022-03-22 21:30:04,733 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:30:04,735 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:30:04,754 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:30:04,759 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:30:04,761 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:30:04,765 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:30:05,619 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:30:05,626 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:30:06,575 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:30:06,583 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:30:06,600 p=86467 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:30:06,601 p=86467 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:30:11,610 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:30:11,619 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:30:12,487 p=84842 u=rob n=ansible | ok: [eveng] => (item=5) +2022-03-22 21:30:12,495 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:30:12,513 p=86488 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:30:12,513 p=86488 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:30:17,520 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:30:17,532 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:30:17,549 p=86489 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:30:17,550 p=86489 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:30:47,557 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:30:47,568 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:30:47,606 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:30:47,615 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:30:47,626 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:30:48,497 p=86496 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:30:48,497 p=86497 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:30:49,152 p=86506 u=rob n=p=86506 u=rob | paramiko [dhcp-server] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:30:49,155 p=86505 u=rob n=p=86505 u=rob | paramiko [dhcp-relay] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:30:49,248 p=86506 u=rob n=p=86506 u=rob | paramiko [dhcp-server] | Authentication (publickey) successful! +2022-03-22 21:30:49,251 p=86505 u=rob n=p=86505 u=rob | paramiko [dhcp-relay] | Authentication (publickey) successful! +2022-03-22 21:30:55,039 p=84842 u=rob n=ansible | ok: [dhcp-relay] => (item=172.16.0.1) +2022-03-22 21:30:55,099 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=172.16.0.2) +2022-03-22 21:31:00,281 p=84842 u=rob n=ansible | ok: [dhcp-server] => (item=192.168.0.30) +2022-03-22 21:31:00,287 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:31:00,312 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:31:00,319 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,320 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,322 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:00,328 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:00,331 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:31:00,351 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:31:00,356 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,357 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,364 p=84842 u=rob n=ansible | skipping: [dhcp-server] => (item={'name': 'show_dhcp_server_leases', 'command': 'show dhcp server leases'}) +2022-03-22 21:31:00,365 p=84842 u=rob n=ansible | skipping: [dhcp-server] => (item={'name': 'ping_client', 'command': 'ping 192.168.0.30 count 4'}) +2022-03-22 21:31:00,366 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:00,368 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:31:00,386 p=84842 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:31:00,392 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,393 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,395 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:00,402 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:00,405 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output dir exist] ******************************************************************************************************************************************************** +2022-03-22 21:31:00,427 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,435 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,437 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:00,441 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:00,535 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:31:00,539 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output include dir exist] ************************************************************************************************************************************************ +2022-03-22 21:31:00,560 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,568 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,569 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:00,574 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:00,665 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:31:00,667 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Get timestamp from the system] ***************************************************************************************************************************************************** +2022-03-22 21:31:00,685 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:00,691 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:00,692 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:00,696 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:01,004 p=84842 u=rob n=ansible | changed: [eveng] +2022-03-22 21:31:01,008 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:31:01,031 p=84842 u=rob n=ansible | ok: [eveng] +2022-03-22 21:31:01,037 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:01,038 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:01,038 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:01,042 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:01,046 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : generate lab rst file] ************************************************************************************************************************************************************* +2022-03-22 21:31:01,067 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:01,074 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:01,075 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:01,081 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:01,292 p=84842 u=rob n=ansible | changed: [eveng -> localhost] +2022-03-22 21:31:01,295 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.conf files in Lab] ****************************************************************************************************************************************************** +2022-03-22 21:31:01,317 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:01,324 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:01,325 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:01,330 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:01,479 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:31:01,488 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.conf files] ************************************************************************************************************************************************************* +2022-03-22 21:31:01,512 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:01,520 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:01,520 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:01,526 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:01,779 p=84842 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/DHCPRelay_through_GRE/dhcp-server.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 883, 'inode': 36602631, 'dev': 16777234, 'nlink': 1, 'atime': 1640200319.463196, 'mtime': 1640200318.0973232, 'ctime': 1640200318.0973232, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:31:01,992 p=84842 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/DHCPRelay_through_GRE/dhcp-relay.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 562, 'inode': 36602630, 'dev': 16777234, 'nlink': 1, 'atime': 1640200319.4601443, 'mtime': 1640200318.0971675, 'ctime': 1640200318.0971675, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:31:02,204 p=84842 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/DHCPRelay_through_GRE/transport.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 107, 'inode': 36602635, 'dev': 16777234, 'nlink': 1, 'atime': 1640200319.4603837, 'mtime': 1640200318.098334, 'ctime': 1640200318.098334, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:31:02,208 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.png files in Lab] ******************************************************************************************************************************************************* +2022-03-22 21:31:02,230 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:02,237 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:02,239 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:02,243 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:02,337 p=84842 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:31:02,342 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.png files] ************************************************************************************************************************************************************** +2022-03-22 21:31:02,367 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:02,375 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:02,405 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:02,405 p=84842 u=rob n=ansible | skipping: [transport] +2022-03-22 21:31:02,573 p=84842 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/DHCPRelay_through_GRE/topology.png', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 57080, 'inode': 36602634, 'dev': 16777234, 'nlink': 1, 'atime': 1640200331.2651088, 'mtime': 1640200318.0981731, 'ctime': 1640200318.0981731, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:31:02,576 p=84842 u=rob n=ansible | TASK [eve-ng-lab-test : copy ansible log files] ************************************************************************************************************************************************************ +2022-03-22 21:31:02,597 p=84842 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:31:02,604 p=84842 u=rob n=ansible | skipping: [dhcp-relay] +2022-03-22 21:31:02,606 p=84842 u=rob n=ansible | skipping: [dhcp-server] +2022-03-22 21:31:02,610 p=84842 u=rob n=ansible | skipping: [transport] diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst new file mode 100644 index 00000000..12e81750 --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst @@ -0,0 +1,99 @@ +############################ +DHCP Relay trough GRE-Bridge +############################ + + +| Testdate: 2022-03-22 +| Version: 1.3.1 +| Upgrade Version: 1.4-rolling-202203220701 + + +This simple structure shows how to configure a DHCP Relay over a GRE Bridge +interface. + +******** +Topology +******** + +The topology has 3 VyOS routers and one client. Between the DHCP Server and +the DHCP Relay is a GRE tunnel. The `transport` VyOS represent a large +Network. + +.. image:: _include/topology.png + :alt: Ansible Example topology image + +************* +Configuration +************* + +First, we configure the transport network and the Tunnel interface. + + +Transport: + +.. literalinclude:: _include/transport.conf + :language: none + + +DHCP-Server + +.. literalinclude:: _include/dhcp-server.conf + :language: none + :lines: 1-8 + + +DHCP-Relay + +.. literalinclude:: _include/dhcp-relay.conf + :language: none + :lines: 1-8 + + +After this, we need the DHCP-Server and Relay configuration. +To get a testable result, we just have one IP in the DHCP range. +Expand it as you need it. + +DHCP-Server + +.. literalinclude:: _include/dhcp-server.conf + :language: none + :lines: 9-13 + + +DHCP-Relay + +.. literalinclude:: _include/dhcp-relay.conf + :language: none + :lines: 9-10 + + +*************** +Test the result +*************** + +Ping the Client from the DHCP Server. + + +.. code-block:: none + + vyos@dhcp-server:~$ ping 192.168.0.30 count 4 + PING 192.168.0.30 (192.168.0.30) 56(84) bytes of data. + 64 bytes from 192.168.0.30: icmp_seq=1 ttl=63 time=1.02 ms + 64 bytes from 192.168.0.30: icmp_seq=2 ttl=63 time=1.07 ms + 64 bytes from 192.168.0.30: icmp_seq=3 ttl=63 time=1.24 ms + 64 bytes from 192.168.0.30: icmp_seq=4 ttl=63 time=1.00 ms + + --- 192.168.0.30 ping statistics --- + 4 packets transmitted, 4 received, 0% packet loss, time 7ms + rtt min/avg/max/mdev = 1.001/1.081/1.237/0.098 ms + + +And show all DHCP Leases + + +.. code-block:: none + + vyos@dhcp-server:~$ show dhcp server leases + IP address Hardware address State Lease start Lease expiration Remaining Pool Hostname + ------------ ------------------ ------- ------------------- ------------------- ----------- ---------- ---------- + 192.168.0.30 00:50:79:66:68:05 active 2022/03/22 20:23:12 2022/03/23 20:23:12 23:59:17 DHCPTun100 VPCS diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-relay.conf b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-relay.conf new file mode 100644 index 00000000..1730ac68 --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-relay.conf @@ -0,0 +1,11 @@ +set interfaces ethernet eth1 address '10.0.10.10/24' +set interfaces ethernet eth2 address '192.168.0.254/24' +set interfaces tunnel tun100 address '172.16.0.2/30' +set interfaces tunnel tun100 encapsulation 'gretap' +set interfaces tunnel tun100 remote '10.0.20.10' +set interfaces tunnel tun100 source-address '10.0.10.10' +set protocols static route 0.0.0.0/0 next-hop 172.16.0.1 +set protocols static route 10.0.20.0/24 next-hop 10.0.10.254 +set service dhcp-relay interface 'eth2' +set service dhcp-relay interface 'tun100' +set service dhcp-relay server '172.16.0.1'
\ No newline at end of file diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf new file mode 100644 index 00000000..9c4b612a --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf @@ -0,0 +1,13 @@ +set interfaces ethernet eth1 address '10.0.20.10/24' +set interfaces tunnel tun100 address '172.16.0.1/30' +set interfaces tunnel tun100 encapsulation 'gretap' +set interfaces tunnel tun100 remote '10.0.10.10' +set interfaces tunnel tun100 source-address '10.0.20.10' +set protocols static route 0.0.0.0/0 next-hop 172.16.0.2 +set protocols static route 10.0.10.0/24 next-hop 10.0.20.254 +set protocols static route 192.168.0.0/24 next-hop 127.16.0.2 +set service dhcp-server listen-address '172.16.0.1' +set service dhcp-server shared-network-name DHCPTun100 authoritative +set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 default-router '192.168.0.254' +set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 range 0 start '192.168.0.30' +set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 range 0 stop '192.168.0.30'
\ No newline at end of file diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.png b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.png Binary files differnew file mode 100644 index 00000000..952b664b --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.png diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/transport.conf b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/transport.conf new file mode 100644 index 00000000..1ecebc61 --- /dev/null +++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/transport.conf @@ -0,0 +1,2 @@ +set interfaces ethernet eth1 address '10.0.10.254/24' +set interfaces ethernet eth2 address '10.0.20.254/24'
\ No newline at end of file diff --git a/docs/configexamples/autotest/Wireguard/Wireguard.log b/docs/configexamples/autotest/Wireguard/Wireguard.log index f911274b..898c6e49 100644 --- a/docs/configexamples/autotest/Wireguard/Wireguard.log +++ b/docs/configexamples/autotest/Wireguard/Wireguard.log @@ -1,592 +1,576 @@ -2021-11-30 21:22:56,248 p=89303 u=rob n=ansible | PLAY [prepare node and Lab] *********************************************************************************************************************************************** -2021-11-30 21:22:56,266 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : fail] ****************************************************************************************************************************************** -2021-11-30 21:22:56,286 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:56,293 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:56,293 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:56,297 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:56,300 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : fail] ****************************************************************************************************************************************** -2021-11-30 21:22:56,316 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:56,321 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:56,323 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:56,326 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:56,329 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] **************************************************************************************************************** -2021-11-30 21:22:56,364 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:56,365 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:56,370 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:57,294 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:22:57,301 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : get template facts] **************************************************************************************************************************** -2021-11-30 21:22:57,331 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:57,333 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:57,339 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:57,840 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:22:57,844 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Register path status] ************************************************************************************************************************** -2021-11-30 21:22:57,868 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:57,870 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:57,874 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,203 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:22:58,224 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : create path] *********************************************************************************************************************************** -2021-11-30 21:22:58,243 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,250 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,251 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,255 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,258 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Download iso] ********************************************************************************************************************************** -2021-11-30 21:22:58,273 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,280 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,280 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,284 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,288 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : create virtioa.qcow2 file] ********************************************************************************************************************* -2021-11-30 21:22:58,302 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,308 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,309 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,315 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,317 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] **************************************************************************************************************** -2021-11-30 21:22:58,332 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,339 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,339 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,343 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,346 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : create lab for node install] ******************************************************************************************************************* -2021-11-30 21:22:58,359 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,366 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,368 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,372 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,374 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : open lab] ************************************************************************************************************************************** -2021-11-30 21:22:58,389 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,396 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,396 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,400 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,403 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] ************************************************************************************************************************************** -2021-11-30 21:22:58,417 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,423 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,425 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,428 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,430 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : add node to lab] ******************************************************************************************************************************* -2021-11-30 21:22:58,443 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,448 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,450 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,453 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,455 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : start node] ************************************************************************************************************************************ -2021-11-30 21:22:58,467 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,473 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,475 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,479 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,481 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : get node infos] ******************************************************************************************************************************** -2021-11-30 21:22:58,493 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,498 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,501 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,504 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,506 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] ************************************************************************************************************************************** -2021-11-30 21:22:58,520 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,525 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,527 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,530 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,533 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : copy file] ************************************************************************************************************************************* -2021-11-30 21:22:58,545 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,551 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,553 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,556 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,558 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : run expect script] ***************************************************************************************************************************** -2021-11-30 21:22:58,570 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,575 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,577 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,581 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,583 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie (due timeout)] ************************************************************************************************** -2021-11-30 21:22:58,596 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,601 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,603 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,606 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,611 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : stop node] ************************************************************************************************************************************* -2021-11-30 21:22:58,625 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,631 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,633 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,636 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,639 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : Pause to wait node is shutdown] **************************************************************************************************************** -2021-11-30 21:22:58,648 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,650 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : delete iso] ************************************************************************************************************************************ -2021-11-30 21:22:58,664 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,668 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,670 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,673 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,675 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : commit virtioa.qcow2] ************************************************************************************************************************** -2021-11-30 21:22:58,688 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,694 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,696 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,699 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,701 p=89303 u=rob n=ansible | TASK [eve-ng-create-node : delete lab for node install] ******************************************************************************************************************* -2021-11-30 21:22:58,714 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,719 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,721 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,724 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,730 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ********************************************************************************************************************************************* -2021-11-30 21:22:58,742 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:22:58,748 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,749 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,753 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:58,756 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ******************************************************************************************************************* -2021-11-30 21:22:58,773 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:58,775 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:58,779 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:59,454 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:22:59,458 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : get running lab list] ***************************************************************************************************************************** -2021-11-30 21:22:59,479 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:22:59,481 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:22:59,487 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:22:59,982 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:22:59,987 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : delete existing lab] ****************************************************************************************************************************** -2021-11-30 21:23:00,016 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:00,018 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:00,024 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:00,484 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:00,491 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Ensure labtest is present] ************************************************************************************************************************ -2021-11-30 21:23:00,530 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:00,532 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:00,537 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:00,878 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:00,884 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Create Wireguard Lab] ***************************************************************************************************************************** -2021-11-30 21:23:00,910 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:00,911 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:00,917 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:01,583 p=89303 u=rob n=ansible | changed: [eveng] -2021-11-30 21:23:01,587 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ******************************************************************************************************************* -2021-11-30 21:23:01,612 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:01,614 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:01,618 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:02,244 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:02,250 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : start vyos-oobm] ********************************************************************************************************************************** -2021-11-30 21:23:02,278 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:02,279 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:02,285 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:03,225 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:03,231 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos-oobm] ******************************************************************************************************************************* -2021-11-30 21:23:03,252 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:23:03,262 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:03,268 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:46,323 p=89303 u=rob n=ansible | ok: [vyos-oobm] -2021-11-30 21:23:46,330 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ******************************************************************************************************************* -2021-11-30 21:23:46,360 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:46,362 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:46,367 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:47,089 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:47,094 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : get lab status] *********************************************************************************************************************************** -2021-11-30 21:23:47,121 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:47,122 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:47,129 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:47,599 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:23:47,604 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : start all nodes] ********************************************************************************************************************************** -2021-11-30 21:23:47,633 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:47,635 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:23:47,641 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:23:48,118 p=89303 u=rob n=ansible | ok: [eveng] => (item=1) -2021-11-30 21:23:49,036 p=89303 u=rob n=ansible | ok: [eveng] => (item=4) -2021-11-30 21:23:50,055 p=89303 u=rob n=ansible | ok: [eveng] => (item=6) -2021-11-30 21:23:50,979 p=89303 u=rob n=ansible | ok: [eveng] => (item=2) -2021-11-30 21:23:51,904 p=89303 u=rob n=ansible | ok: [eveng] => (item=3) -2021-11-30 21:23:51,911 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] ****************************************************************************************************************************** -2021-11-30 21:23:51,932 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:23:51,939 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:23:52,888 p=89770 u=rob n=ansible | network_os is set to vyos -2021-11-30 21:23:52,888 p=89771 u=rob n=ansible | network_os is set to vyos -2021-11-30 21:24:07,909 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner -2021-11-30 21:24:07,913 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:24:07,913 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | raise socket.timeout() -2021-11-30 21:24:07,914 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:24:07,914 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | socket.timeout -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | buf += self._read_timeout(timeout) -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | raise socket.timeout() -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | self._check_banner() -2021-11-30 21:24:07,915 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | socket.timeout -2021-11-30 21:24:07,915 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:07,916 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | raise SSHException( -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: -2021-11-30 21:24:07,916 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:07,916 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | self._check_banner() -2021-11-30 21:24:07,916 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:24:07,917 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | raise SSHException( -2021-11-30 21:24:07,917 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:24:07,917 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:23,955 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | buf += self._read_timeout(timeout) -2021-11-30 21:24:23,956 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | raise socket.timeout() -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | socket.timeout -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:24:23,957 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | self._check_banner() -2021-11-30 21:24:23,958 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:24:23,958 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | raise SSHException( -2021-11-30 21:24:23,958 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:24:23,958 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | -2021-11-30 21:24:23,961 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) -2021-11-30 21:24:23,962 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | raise socket.timeout() -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | socket.timeout -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:24:23,963 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:24:23,964 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | self._check_banner() -2021-11-30 21:24:23,964 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:24:23,964 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | raise SSHException( -2021-11-30 21:24:23,964 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:24:23,964 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | -2021-11-30 21:24:26,169 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:24:26,169 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:24:26,260 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:24:26,260 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:24:26,260 p=89770 u=rob n=p=89770 u=rob | paramiko [central] | Authentication (publickey) successful! -2021-11-30 21:24:26,261 p=89771 u=rob n=p=89771 u=rob | paramiko [branch] | Authentication (publickey) successful! -2021-11-30 21:24:27,157 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:24:27,157 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:24:27,159 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : include Wireguard lab_config.yml] ***************************************************************************************************************** -2021-11-30 21:24:27,174 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:24:27,180 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:24:27,193 p=89303 u=rob n=ansible | included: /Users/rob/git/_vyos/vyos-eveng/labs/Wireguard/lab_config.yml for central, branch -2021-11-30 21:24:27,210 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : show wireguard keypairs pubkey default] *********************************************************************************************************** -2021-11-30 21:24:29,104 p=89778 u=rob n=p=89778 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:24:29,189 p=89778 u=rob n=p=89778 u=rob | paramiko [central] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:24:29,190 p=89778 u=rob n=p=89778 u=rob | paramiko [central] | Authentication (publickey) successful! -2021-11-30 21:24:29,360 p=89779 u=rob n=p=89779 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:24:29,446 p=89779 u=rob n=p=89779 u=rob | paramiko [branch] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:24:29,446 p=89779 u=rob n=p=89779 u=rob | paramiko [branch] | Authentication (publickey) successful! -2021-11-30 21:24:30,768 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:24:30,999 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:24:31,006 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ********************************************************************************************************************************************* -2021-11-30 21:24:31,876 p=89303 u=rob n=ansible | fatal: [central]: FAILED! => {"changed": false, "msg": "Failed as requested from task"} -2021-11-30 21:24:31,876 p=89303 u=rob n=ansible | fatal: [branch]: FAILED! => {"changed": false, "msg": "Failed as requested from task"} -2021-11-30 21:24:31,887 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : generate wireguard default-keypair] *************************************************************************************************************** -2021-11-30 21:24:33,253 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:24:33,253 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:24:33,260 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : show wireguard keypairs pubkey default] *********************************************************************************************************** -2021-11-30 21:24:34,603 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:24:34,604 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:24:34,619 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : setup nodes] ************************************************************************************************************************************** -2021-11-30 21:24:40,906 p=89303 u=rob n=ansible | [WARNING]: To ensure idempotency and correct diff the input configuration lines should be similar to how they appear if present in the running configuration on device -including the indentation +2022-03-22 21:49:47,088 p=88039 u=rob n=ansible | PLAY [prepare node and Lab] ******************************************************************************************************************************************************************************** +2022-03-22 21:49:47,107 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : fail] *************************************************************************************************************************************************************************** +2022-03-22 21:49:47,122 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:47,128 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:47,130 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:47,132 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:47,135 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : fail] *************************************************************************************************************************************************************************** +2022-03-22 21:49:47,146 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:47,152 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:47,154 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:47,159 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:47,161 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************************************************************************************* +2022-03-22 21:49:47,180 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:47,182 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:47,185 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:48,087 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:48,092 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : get template facts] ************************************************************************************************************************************************************* +2022-03-22 21:49:48,119 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:48,120 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:48,126 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:48,575 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:48,581 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Register path status] *********************************************************************************************************************************************************** +2022-03-22 21:49:48,609 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:48,609 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:48,616 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:48,934 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:48,937 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : create path] ******************************************************************************************************************************************************************** +2022-03-22 21:49:48,952 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:48,960 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:48,961 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:48,965 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:48,967 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Download iso] ******************************************************************************************************************************************************************* +2022-03-22 21:49:48,981 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:48,986 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:48,987 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:48,992 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:48,995 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : create virtioa.qcow2 file] ****************************************************************************************************************************************************** +2022-03-22 21:49:49,009 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,015 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,017 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,020 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,022 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************************************************************************************* +2022-03-22 21:49:49,036 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,041 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,044 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,048 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,051 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : create lab for node install] **************************************************************************************************************************************************** +2022-03-22 21:49:49,064 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,070 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,072 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,076 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,078 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : open lab] *********************************************************************************************************************************************************************** +2022-03-22 21:49:49,090 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,096 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,098 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,101 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,104 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] *********************************************************************************************************************************************************************** +2022-03-22 21:49:49,116 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,121 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,123 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,126 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,128 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : add node to lab] **************************************************************************************************************************************************************** +2022-03-22 21:49:49,142 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,148 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,150 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,152 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,154 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : start node] ********************************************************************************************************************************************************************* +2022-03-22 21:49:49,168 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,173 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,175 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,179 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,181 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : get node infos] ***************************************************************************************************************************************************************** +2022-03-22 21:49:49,193 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,199 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,201 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,203 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,205 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] *********************************************************************************************************************************************************************** +2022-03-22 21:49:49,217 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,222 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,224 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,227 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,229 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : copy file] ********************************************************************************************************************************************************************** +2022-03-22 21:49:49,243 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,248 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,250 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,253 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,255 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : run expect script] ************************************************************************************************************************************************************** +2022-03-22 21:49:49,267 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,272 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,274 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,277 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,279 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie (due timeout)] *********************************************************************************************************************************** +2022-03-22 21:49:49,290 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,296 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,297 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,300 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,302 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : stop node] ********************************************************************************************************************************************************************** +2022-03-22 21:49:49,315 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,321 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,323 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,326 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,328 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : Pause to wait node is shutdown] ************************************************************************************************************************************************* +2022-03-22 21:49:49,337 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,339 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : delete iso] ********************************************************************************************************************************************************************* +2022-03-22 21:49:49,350 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,356 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,358 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,361 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,363 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : commit virtioa.qcow2] *********************************************************************************************************************************************************** +2022-03-22 21:49:49,376 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,384 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,385 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,388 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,390 p=88039 u=rob n=ansible | TASK [eve-ng-create-node : delete lab for node install] **************************************************************************************************************************************************** +2022-03-22 21:49:49,402 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:49,409 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:49,409 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:49,413 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:49,420 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Get env file content] ************************************************************************************************************************************************************** +2022-03-22 21:49:49,608 p=88039 u=rob n=ansible | ok: [vyos-oobm -> localhost] +2022-03-22 21:49:49,608 p=88039 u=rob n=ansible | ok: [central -> localhost] +2022-03-22 21:49:49,609 p=88039 u=rob n=ansible | ok: [branch -> localhost] +2022-03-22 21:49:49,609 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:49:49,610 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Load facts] ************************************************************************************************************************************************************************ +2022-03-22 21:49:49,629 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:49,630 p=88039 u=rob n=ansible | ok: [vyos-oobm] +2022-03-22 21:49:50,525 p=88289 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:49:50,525 p=88288 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:49:50,534 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:49:50,534 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:49:50,541 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ****************************************************************************************************************************************************************************** +2022-03-22 21:49:50,564 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:50,573 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:50,574 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:50,580 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:50,583 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:49:50,605 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:50,606 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:50,610 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:51,264 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:51,269 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : get running lab list] ************************************************************************************************************************************************************** +2022-03-22 21:49:51,295 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:51,298 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:51,303 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:51,775 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:51,780 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : delete existing lab] *************************************************************************************************************************************************************** +2022-03-22 21:49:51,808 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:51,810 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:51,816 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:52,426 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:52,432 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Ensure labtest is present] ********************************************************************************************************************************************************* +2022-03-22 21:49:52,457 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:52,458 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:52,463 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:52,785 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:52,789 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Create Wireguard Lab] ************************************************************************************************************************************************************** +2022-03-22 21:49:52,811 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:52,812 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:52,818 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:53,459 p=88039 u=rob n=ansible | changed: [eveng] +2022-03-22 21:49:53,462 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:49:53,483 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:53,485 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:53,489 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:54,102 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:54,108 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : start vyos-oobm] ******************************************************************************************************************************************************************* +2022-03-22 21:49:54,134 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:49:54,136 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:54,142 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:49:55,076 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:49:55,082 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos-oobm] **************************************************************************************************************************************************************** +2022-03-22 21:49:55,101 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:49:55,110 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:49:55,117 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:50:58,422 p=88039 u=rob n=ansible | ok: [vyos-oobm] +2022-03-22 21:50:58,428 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:50:58,454 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:50:58,456 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:50:58,461 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:50:59,261 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:50:59,266 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : get lab status] ******************************************************************************************************************************************************************** +2022-03-22 21:50:59,293 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:50:59,295 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:50:59,300 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:50:59,762 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:50:59,768 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : start all nodes] ******************************************************************************************************************************************************************* +2022-03-22 21:50:59,796 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:50:59,800 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:50:59,806 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:51:00,260 p=88039 u=rob n=ansible | ok: [eveng] => (item=1) +2022-03-22 21:51:01,133 p=88039 u=rob n=ansible | ok: [eveng] => (item=4) +2022-03-22 21:51:02,128 p=88039 u=rob n=ansible | ok: [eveng] => (item=6) +2022-03-22 21:51:02,990 p=88039 u=rob n=ansible | ok: [eveng] => (item=2) +2022-03-22 21:51:03,927 p=88039 u=rob n=ansible | ok: [eveng] => (item=3) +2022-03-22 21:51:03,934 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:51:03,954 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:51:03,961 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:51:19,898 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner +2022-03-22 21:51:19,901 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Traceback (most recent call last): +2022-03-22 21:51:19,901 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:51:19,901 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) +2022-03-22 21:51:19,901 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:51:19,901 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | raise socket.timeout() +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | socket.timeout +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Traceback (most recent call last): +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:51:19,902 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | self._check_banner() +2022-03-22 21:51:19,903 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:51:19,903 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | raise SSHException( +2022-03-22 21:51:19,903 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:51:19,903 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:19,903 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner +2022-03-22 21:51:19,904 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Traceback (most recent call last): +2022-03-22 21:51:19,904 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:51:19,904 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) +2022-03-22 21:51:19,904 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | buf += self._read_timeout(timeout) +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | raise socket.timeout() +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | socket.timeout +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:19,905 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Traceback (most recent call last): +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | self._check_banner() +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | raise SSHException( +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:51:19,906 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:35,929 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner +2022-03-22 21:51:35,930 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Traceback (most recent call last): +2022-03-22 21:51:35,930 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:51:35,930 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | raise socket.timeout() +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | socket.timeout +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: +2022-03-22 21:51:35,931 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Traceback (most recent call last): +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | self._check_banner() +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | raise SSHException( +2022-03-22 21:51:35,932 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:51:35,933 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | +2022-03-22 21:51:35,936 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Traceback (most recent call last): +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | buf += self._read_timeout(timeout) +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | raise socket.timeout() +2022-03-22 21:51:35,937 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | socket.timeout +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Traceback (most recent call last): +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | self._check_banner() +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | raise SSHException( +2022-03-22 21:51:35,938 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-22 21:51:35,939 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | +2022-03-22 21:51:37,441 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:51:37,452 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:51:37,521 p=88608 u=rob n=p=88608 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:51:37,524 p=88607 u=rob n=p=88607 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:51:38,411 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:51:38,411 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:51:38,413 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : include Wireguard lab_config.yml] ************************************************************************************************************************************************** +2022-03-22 21:51:38,426 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:51:38,433 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:51:38,446 p=88039 u=rob n=ansible | included: /Users/rob/git/_vyos/vyos-eveng/labs/Wireguard/lab_config.yml for central, branch +2022-03-22 21:51:38,468 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : show wireguard keypairs pubkey default] ******************************************************************************************************************************************** +2022-03-22 21:51:40,040 p=88298 u=rob n=p=88298 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:51:40,066 p=88297 u=rob n=p=88297 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:51:40,102 p=88298 u=rob n=p=88298 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:51:40,123 p=88297 u=rob n=p=88297 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:51:41,698 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:51:41,699 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:51:41,704 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ****************************************************************************************************************************************************************************** +2022-03-22 21:51:42,571 p=88039 u=rob n=ansible | fatal: [central]: FAILED! => {"changed": false, "msg": "Failed as requested from task"} +2022-03-22 21:51:42,572 p=88039 u=rob n=ansible | fatal: [branch]: FAILED! => {"changed": false, "msg": "Failed as requested from task"} +2022-03-22 21:51:42,581 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : generate wireguard default-keypair] ************************************************************************************************************************************************ +2022-03-22 21:51:43,905 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:51:43,912 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:51:43,916 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : show wireguard keypairs pubkey default] ******************************************************************************************************************************************** +2022-03-22 21:51:45,236 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:51:45,237 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:51:45,249 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : setup nodes] *********************************************************************************************************************************************************************** +2022-03-22 21:51:51,772 p=88039 u=rob n=ansible | [WARNING]: To ensure idempotency and correct diff the input configuration lines should be similar to how they appear if present in the running configuration on device including the indentation -2021-11-30 21:24:40,906 p=89303 u=rob n=ansible | changed: [central] -2021-11-30 21:24:40,917 p=89303 u=rob n=ansible | changed: [branch] -2021-11-30 21:24:40,921 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ******************************************************************************************** -2021-11-30 21:24:40,929 p=89987 u=rob n=ansible | Pausing for 30 seconds -2021-11-30 21:24:40,930 p=89987 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
-2021-11-30 21:25:10,937 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:25:10,945 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ************************************************************************************************************************************* -2021-11-30 21:25:10,970 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:10,981 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:16,391 p=89303 u=rob n=ansible | ok: [central] => (item=10.0.2.100) -2021-11-30 21:25:16,392 p=89303 u=rob n=ansible | ok: [branch] => (item=10.0.1.100) -2021-11-30 21:25:16,396 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] **************************************************************************************************************************** -2021-11-30 21:25:16,415 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:16,423 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:17,672 p=89303 u=rob n=ansible | ok: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) -2021-11-30 21:25:17,959 p=89303 u=rob n=ansible | ok: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) -2021-11-30 21:25:18,226 p=89303 u=rob n=ansible | ok: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) -2021-11-30 21:25:18,232 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ************************************************************************************************************************* -2021-11-30 21:25:18,256 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:18,256 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:19,621 p=89303 u=rob n=ansible | ok: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:25:19,622 p=89303 u=rob n=ansible | ok: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:25:23,037 p=89303 u=rob n=ansible | ok: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) -2021-11-30 21:25:23,042 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ************************************************************************************************************************************ -2021-11-30 21:25:23,060 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:23,067 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:23,940 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:25:23,941 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:25:23,947 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] ************************************************************************************************************************************** -2021-11-30 21:25:23,970 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:23,979 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:25,220 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:25:25,220 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:25:25,223 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] ****************************************************************************************************************************** -2021-11-30 21:25:25,234 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:25,237 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] ****************************************************************************************************************************** -2021-11-30 21:25:25,255 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:25:25,261 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:25:26,973 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:25:27,064 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:25:27,065 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' -2021-11-30 21:25:27,194 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:25:27,244 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:25:27,244 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' -2021-11-30 21:26:25,479 p=89778 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 60 secs. +2022-03-22 21:51:51,773 p=88039 u=rob n=ansible | changed: [branch] +2022-03-22 21:51:51,773 p=88039 u=rob n=ansible | changed: [central] +2022-03-22 21:51:51,776 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:51:51,801 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:51:51,801 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:51:51,806 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:51:52,462 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:51:52,467 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:51:52,510 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:51:52,519 p=88842 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:51:52,519 p=88842 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:51:57,524 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:51:57,528 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:51:57,570 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:51:57,578 p=88848 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:51:57,578 p=88848 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:52:02,583 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:52:02,586 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:52:02,595 p=88849 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:52:02,595 p=88849 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:52:32,604 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:52:32,610 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:52:32,638 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:32,638 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:37,998 p=88039 u=rob n=ansible | ok: [central] => (item=10.0.2.100) +2022-03-22 21:52:38,055 p=88039 u=rob n=ansible | ok: [branch] => (item=10.0.1.100) +2022-03-22 21:52:38,058 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:52:38,078 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:38,079 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:39,295 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) +2022-03-22 21:52:39,470 p=88039 u=rob n=ansible | ok: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) +2022-03-22 21:52:39,755 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) +2022-03-22 21:52:39,760 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:52:39,783 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:39,784 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:41,118 p=88039 u=rob n=ansible | ok: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:52:41,120 p=88039 u=rob n=ansible | ok: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:52:44,542 p=88039 u=rob n=ansible | ok: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) +2022-03-22 21:52:44,548 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:52:44,570 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:44,572 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:45,416 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:52:45,416 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:52:45,422 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] *********************************************************************************************************************************************************************** +2022-03-22 21:52:45,445 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:45,453 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:46,656 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:52:46,657 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:52:46,660 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] *************************************************************************************************************************************************************** +2022-03-22 21:52:46,670 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:46,673 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:52:46,687 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:52:46,692 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:52:48,073 p=89062 u=rob n=p=89062 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:52:48,073 p=89063 u=rob n=p=89063 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:52:48,158 p=89062 u=rob n=p=89062 u=rob | paramiko [central] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:52:48,158 p=89063 u=rob n=p=89063 u=rob | paramiko [branch] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:54:46,902 p=88297 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. See the timeout setting options in the Network Debug and Troubleshooting Guide. -2021-11-30 21:26:25,480 p=89779 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 60 secs. +2022-03-22 21:54:46,901 p=88298 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. See the timeout setting options in the Network Debug and Troubleshooting Guide. -2021-11-30 21:26:25,584 p=89778 u=rob n=ansible | shutdown complete -2021-11-30 21:26:25,584 p=89779 u=rob n=ansible | shutdown complete -2021-11-30 21:26:43,068 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner -2021-11-30 21:26:43,070 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:26:43,070 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:26:43,070 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) -2021-11-30 21:26:43,070 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:26:43,070 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise socket.timeout() -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | socket.timeout -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: -2021-11-30 21:26:43,071 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | self._check_banner() -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise SSHException( -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:26:43,072 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:43,252 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner -2021-11-30 21:26:43,252 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | buf += self._read_timeout(timeout) -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | raise socket.timeout() -2021-11-30 21:26:43,253 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | socket.timeout -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | self._check_banner() -2021-11-30 21:26:43,254 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:26:43,255 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | raise SSHException( -2021-11-30 21:26:43,255 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:26:43,255 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:26:59,086 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner -2021-11-30 21:26:59,087 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:26:59,087 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:26:59,087 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) -2021-11-30 21:26:59,087 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:26:59,087 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise socket.timeout() -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | socket.timeout -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: -2021-11-30 21:26:59,088 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | self._check_banner() -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise SSHException( -2021-11-30 21:26:59,089 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:26:59,090 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:26:59,269 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Exception: Error reading SSH protocol banner -2021-11-30 21:26:59,269 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:26:59,269 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | buf = self.packetizer.readline(timeout) -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | buf += self._read_timeout(timeout) -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | raise socket.timeout() -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | socket.timeout -2021-11-30 21:26:59,270 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | During handling of the above exception, another exception occurred: -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Traceback (most recent call last): -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | self._check_banner() -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:26:59,271 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | raise SSHException( -2021-11-30 21:26:59,272 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:26:59,272 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | -2021-11-30 21:27:00,910 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:27:01,000 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:27:01,001 p=90198 u=rob n=p=90198 u=rob | paramiko [central] | Authentication (publickey) successful! -2021-11-30 21:27:02,087 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:27:15,106 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Exception: Error reading SSH protocol banner -2021-11-30 21:27:15,106 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:27:15,106 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf = self.packetizer.readline(timeout) -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | buf += self._read_timeout(timeout) -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise socket.timeout() -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | socket.timeout -2021-11-30 21:27:15,107 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | During handling of the above exception, another exception occurred: -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Traceback (most recent call last): -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | self._check_banner() -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | raise SSHException( -2021-11-30 21:27:15,108 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner -2021-11-30 21:27:15,109 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | -2021-11-30 21:27:16,951 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:27:17,048 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:27:17,048 p=90199 u=rob n=p=90199 u=rob | paramiko [branch] | Authentication (publickey) successful! -2021-11-30 21:27:18,189 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:27:18,191 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ******************************************************************************************** -2021-11-30 21:27:18,198 p=90265 u=rob n=ansible | Pausing for 30 seconds -2021-11-30 21:27:18,199 p=90265 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
-2021-11-30 21:27:48,205 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:27:48,214 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ************************************************************************************************************************************* -2021-11-30 21:27:48,239 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:27:48,249 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:27:49,134 p=90272 u=rob n=ansible | network_os is set to vyos -2021-11-30 21:27:49,134 p=90273 u=rob n=ansible | network_os is set to vyos -2021-11-30 21:27:50,902 p=90281 u=rob n=p=90281 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:27:50,903 p=90278 u=rob n=p=90278 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) -2021-11-30 21:27:51,124 p=90281 u=rob n=p=90281 u=rob | paramiko [branch] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:27:51,125 p=90281 u=rob n=p=90281 u=rob | paramiko [branch] | Authentication (publickey) successful! -2021-11-30 21:27:51,129 p=90278 u=rob n=p=90278 u=rob | paramiko [central] | Auth banner: b'Welcome to VyOS\n' -2021-11-30 21:27:51,129 p=90278 u=rob n=p=90278 u=rob | paramiko [central] | Authentication (publickey) successful! -2021-11-30 21:27:56,845 p=89303 u=rob n=ansible | ok: [branch] => (item=10.0.1.100) -2021-11-30 21:27:56,850 p=89303 u=rob n=ansible | ok: [central] => (item=10.0.2.100) -2021-11-30 21:27:56,854 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] **************************************************************************************************************************** -2021-11-30 21:27:56,872 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:27:56,881 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:27:58,053 p=89303 u=rob n=ansible | ok: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) -2021-11-30 21:27:58,238 p=89303 u=rob n=ansible | ok: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) -2021-11-30 21:27:58,539 p=89303 u=rob n=ansible | ok: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) -2021-11-30 21:27:58,543 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ************************************************************************************************************************* -2021-11-30 21:27:58,563 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:27:58,571 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:27:59,909 p=89303 u=rob n=ansible | ok: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:27:59,914 p=89303 u=rob n=ansible | ok: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:28:03,307 p=89303 u=rob n=ansible | ok: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) -2021-11-30 21:28:03,311 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ************************************************************************************************************************************ -2021-11-30 21:28:03,329 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:03,335 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,194 p=89303 u=rob n=ansible | ok: [branch] -2021-11-30 21:28:04,195 p=89303 u=rob n=ansible | ok: [central] -2021-11-30 21:28:04,204 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : make sure tmp dir exist] ************************************************************************************************************************** -2021-11-30 21:28:04,233 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,244 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,244 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,250 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,254 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Download upgrade_iso] ***************************************************************************************************************************** -2021-11-30 21:28:04,267 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,276 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,284 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,288 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,294 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Copy iso to host] ********************************************************************************************************************************* -2021-11-30 21:28:04,309 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,315 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,317 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,320 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,322 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : upgrade vyos] ************************************************************************************************************************************* -2021-11-30 21:28:04,337 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,344 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,345 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,348 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,350 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] ************************************************************************************************************************************** -2021-11-30 21:28:04,365 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,373 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,374 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,377 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,379 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] ****************************************************************************************************************************** -2021-11-30 21:28:04,387 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,389 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] ****************************************************************************************************************************** -2021-11-30 21:28:04,401 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,407 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,409 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,411 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,415 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : clear tmp dir] ************************************************************************************************************************************ -2021-11-30 21:28:04,422 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,424 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ******************************************************************************************** -2021-11-30 21:28:04,432 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,435 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ************************************************************************************************************************************* -2021-11-30 21:28:04,448 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,453 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,459 p=89303 u=rob n=ansible | skipping: [central] => (item=10.0.2.100) -2021-11-30 21:28:04,464 p=89303 u=rob n=ansible | skipping: [branch] => (item=10.0.1.100) -2021-11-30 21:28:04,467 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] **************************************************************************************************************************** -2021-11-30 21:28:04,480 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,486 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,493 p=89303 u=rob n=ansible | skipping: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) -2021-11-30 21:28:04,493 p=89303 u=rob n=ansible | skipping: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) -2021-11-30 21:28:04,498 p=89303 u=rob n=ansible | skipping: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) -2021-11-30 21:28:04,501 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ************************************************************************************************************************* -2021-11-30 21:28:04,516 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,522 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,529 p=89303 u=rob n=ansible | skipping: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:28:04,529 p=89303 u=rob n=ansible | skipping: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) -2021-11-30 21:28:04,533 p=89303 u=rob n=ansible | skipping: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) -2021-11-30 21:28:04,535 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ************************************************************************************************************************************ -2021-11-30 21:28:04,549 p=89303 u=rob n=ansible | skipping: [eveng] -2021-11-30 21:28:04,555 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,556 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,559 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,562 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output dir exist] *********************************************************************************************************************** -2021-11-30 21:28:04,585 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,586 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,590 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,753 p=89303 u=rob n=ansible | changed: [eveng -> localhost] -2021-11-30 21:28:04,756 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output include dir exist] *************************************************************************************************************** -2021-11-30 21:28:04,780 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,781 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,785 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:04,883 p=89303 u=rob n=ansible | changed: [eveng -> localhost] -2021-11-30 21:28:04,885 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Get timestamp from the system] ******************************************************************************************************************** -2021-11-30 21:28:04,906 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:04,907 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:04,911 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:05,439 p=89303 u=rob n=ansible | changed: [eveng] -2021-11-30 21:28:05,442 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ************************************************************************************************************************************ -2021-11-30 21:28:05,461 p=89303 u=rob n=ansible | ok: [eveng] -2021-11-30 21:28:05,463 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:05,464 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:05,470 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:05,473 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : generate lab rst file] **************************************************************************************************************************** -2021-11-30 21:28:05,499 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:05,500 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:05,504 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:05,714 p=89303 u=rob n=ansible | changed: [eveng -> localhost] -2021-11-30 21:28:05,718 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.conf files in Lab] ********************************************************************************************************************* -2021-11-30 21:28:05,742 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:05,743 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:05,747 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:05,905 p=89303 u=rob n=ansible | ok: [eveng -> localhost] -2021-11-30 21:28:05,914 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.conf files] **************************************************************************************************************************** -2021-11-30 21:28:05,933 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:05,942 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:05,947 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:06,143 p=89303 u=rob n=ansible | changed: [eveng -> localhost] => (item={'path': 'labs/Wireguard/branch.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 694, 'inode': 33275439, 'dev': 16777233, 'nlink': 1, 'atime': 1638303429.4263835, 'mtime': 1638303428.1385503, 'ctime': 1638303428.1385503, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) -2021-11-30 21:28:06,350 p=89303 u=rob n=ansible | changed: [eveng -> localhost] => (item={'path': 'labs/Wireguard/central.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 687, 'inode': 33275440, 'dev': 16777233, 'nlink': 1, 'atime': 1638303429.426384, 'mtime': 1638303428.1388185, 'ctime': 1638303428.1388185, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) -2021-11-30 21:28:06,354 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.png files in Lab] ********************************************************************************************************************** -2021-11-30 21:28:06,377 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:06,378 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:06,382 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:06,478 p=89303 u=rob n=ansible | ok: [eveng -> localhost] -2021-11-30 21:28:06,483 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.png files] ***************************************************************************************************************************** -2021-11-30 21:28:06,510 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:06,511 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:06,517 p=89303 u=rob n=ansible | skipping: [branch] -2021-11-30 21:28:06,710 p=89303 u=rob n=ansible | changed: [eveng -> localhost] => (item={'path': 'labs/Wireguard/topology.png', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 158227, 'inode': 31651192, 'dev': 16777233, 'nlink': 1, 'atime': 1637677693.6729753, 'mtime': 1637092135.8691404, 'ctime': 1637092174.4312608, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) -2021-11-30 21:28:06,714 p=89303 u=rob n=ansible | TASK [eve-ng-lab-test : copy ansible log files] *************************************************************************************************************************** -2021-11-30 21:28:06,737 p=89303 u=rob n=ansible | skipping: [vyos-oobm] -2021-11-30 21:28:06,738 p=89303 u=rob n=ansible | skipping: [central] -2021-11-30 21:28:06,742 p=89303 u=rob n=ansible | skipping: [branch] +2022-03-22 21:54:47,007 p=88298 u=rob n=ansible | shutdown complete +2022-03-22 21:54:47,007 p=88297 u=rob n=ansible | shutdown complete +2022-03-22 21:54:49,907 p=89062 u=rob n=p=89062 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:54:49,907 p=89063 u=rob n=p=89063 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:54:49,985 p=89062 u=rob n=p=89062 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:54:49,987 p=89063 u=rob n=p=89063 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:54:51,093 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:54:51,095 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:54:51,097 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:54:51,115 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:54:51,116 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:54:51,120 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:54:52,022 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:54:52,027 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:54:52,072 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:54:52,081 p=89145 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:54:52,081 p=89145 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:54:57,093 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:54:57,098 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:54:57,148 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:54:57,157 p=89152 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:54:57,157 p=89152 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:55:02,165 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:55:02,170 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:55:02,184 p=89153 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:55:02,185 p=89153 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:55:32,190 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:55:32,196 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:55:32,227 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:55:32,228 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:33,145 p=89163 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:55:33,145 p=89162 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:55:33,846 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:33,850 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:33,927 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:55:33,927 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:55:40,743 p=88039 u=rob n=ansible | ok: [central] => (item=10.0.2.100) +2022-03-22 21:55:40,744 p=88039 u=rob n=ansible | ok: [branch] => (item=10.0.1.100) +2022-03-22 21:55:40,749 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:55:40,771 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:55:40,771 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:41,917 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) +2022-03-22 21:55:42,091 p=88039 u=rob n=ansible | ok: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) +2022-03-22 21:55:42,373 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) +2022-03-22 21:55:42,377 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:55:42,399 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:55:42,400 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:42,408 p=88039 u=rob n=ansible | skipping: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:55:42,409 p=88039 u=rob n=ansible | skipping: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) +2022-03-22 21:55:42,413 p=88039 u=rob n=ansible | skipping: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:55:42,417 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:55:42,436 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:55:42,437 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:42,439 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:55:42,445 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:55:42,448 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : make sure tmp dir exist] *********************************************************************************************************************************************************** +2022-03-22 21:55:42,482 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:42,484 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:55:42,488 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:55:42,671 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:55:42,674 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : register status of tmp/vyos-1.4-rolling-202203220701-amd64.iso] ******************************************************************************************************************** +2022-03-22 21:55:42,693 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:42,695 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:55:42,699 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:55:42,946 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:55:42,952 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Download upgrade_iso] ************************************************************************************************************************************************************** +2022-03-22 21:55:42,978 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:42,980 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:55:42,984 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:55:43,783 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:55:43,790 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Copy iso to host] ****************************************************************************************************************************************************************** +2022-03-22 21:55:43,806 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:55:43,812 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:55:45,167 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:45,171 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:45,244 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:55:45,244 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:55:45,973 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:45,980 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:55:46,053 p=89171 u=rob n=p=89171 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:55:46,053 p=89170 u=rob n=p=89170 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:56:11,645 p=88039 u=rob n=ansible | changed: [branch] +2022-03-22 21:56:11,652 p=88039 u=rob n=ansible | changed: [central] +2022-03-22 21:56:11,657 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : upgrade vyos] ********************************************************************************************************************************************************************** +2022-03-22 21:56:11,674 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:56:11,680 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:56:22,152 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:56:22,152 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:56:22,155 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] *********************************************************************************************************************************************************************** +2022-03-22 21:56:22,172 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:56:22,179 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:56:23,672 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:56:23,673 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:56:23,677 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] *************************************************************************************************************************************************************** +2022-03-22 21:56:23,689 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:56:23,691 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] *************************************************************************************************************************************************************** +2022-03-22 21:56:23,705 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:56:23,711 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:56:25,186 p=89479 u=rob n=p=89479 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:56:25,208 p=89478 u=rob n=p=89478 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-22 21:56:25,295 p=89479 u=rob n=p=89479 u=rob | paramiko [branch] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:56:25,299 p=89478 u=rob n=p=89478 u=rob | paramiko [central] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-22 21:58:23,919 p=89170 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:58:23,924 p=89171 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-22 21:58:24,025 p=89170 u=rob n=ansible | shutdown complete +2022-03-22 21:58:24,028 p=89171 u=rob n=ansible | shutdown complete +2022-03-22 21:58:26,872 p=89478 u=rob n=p=89478 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:58:26,874 p=89479 u=rob n=p=89479 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:58:26,938 p=89479 u=rob n=p=89479 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:58:26,949 p=89478 u=rob n=p=89478 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:58:28,320 p=88039 u=rob n=ansible | ok: [branch] +2022-03-22 21:58:28,336 p=88039 u=rob n=ansible | ok: [central] +2022-03-22 21:58:28,339 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : clear tmp dir] ********************************************************************************************************************************************************************* +2022-03-22 21:58:28,348 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:58:28,350 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] **************************************************************************************************************************************************** +2022-03-22 21:58:28,367 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:58:28,369 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:58:28,373 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:58:29,211 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:58:29,218 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************************************************************************************* +2022-03-22 21:58:29,294 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************************************************************************************* +2022-03-22 21:58:29,302 p=89565 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:58:29,303 p=89565 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:58:34,310 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:58:34,317 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ******************************************************************************************************************************************************************** +2022-03-22 21:58:34,367 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ****************************************************************************************************************************************************************** +2022-03-22 21:58:34,376 p=89570 u=rob n=ansible | Pausing for 5 seconds +2022-03-22 21:58:34,377 p=89570 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:58:39,383 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:58:39,389 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ***************************************************************************************************************************** +2022-03-22 21:58:39,403 p=89572 u=rob n=ansible | Pausing for 30 seconds +2022-03-22 21:58:39,404 p=89572 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-22 21:59:09,414 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:59:09,422 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] ********************************************************************************************************************************************************************** +2022-03-22 21:59:09,455 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:59:09,456 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:10,334 p=89579 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:59:10,334 p=89578 u=rob n=ansible | network_os is set to vyos +2022-03-22 21:59:10,931 p=89587 u=rob n=p=89587 u=rob | paramiko [central] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:59:10,935 p=89586 u=rob n=p=89586 u=rob | paramiko [branch] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-22 21:59:11,008 p=89586 u=rob n=p=89586 u=rob | paramiko [branch] | Authentication (publickey) successful! +2022-03-22 21:59:11,008 p=89587 u=rob n=p=89587 u=rob | paramiko [central] | Authentication (publickey) successful! +2022-03-22 21:59:16,598 p=88039 u=rob n=ansible | ok: [central] => (item=10.0.2.100) +2022-03-22 21:59:16,700 p=88039 u=rob n=ansible | ok: [branch] => (item=10.0.1.100) +2022-03-22 21:59:16,706 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************************************************************************************* +2022-03-22 21:59:16,729 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:59:16,730 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:17,882 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'Test if IP is set to interface', 'command': "ip -4 addr show dev eth2 | grep inet | tr -s ' ' | cut -d' ' -f3 | head -n 1", 'wait_for': ['result[0] contains "10.0.1.254/24"']}) +2022-03-22 21:59:18,055 p=88039 u=rob n=ansible | ok: [branch] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.2/24 u/u VPN-to-central"']}) +2022-03-22 21:59:18,344 p=88039 u=rob n=ansible | ok: [central] => (item={'desc': 'show interfaces wireguard', 'command': 'show interfaces wireguard', 'wait_for': ['result[0] contains "S - State, L - Link, u - Up, D - Down, A - Admin Down"', 'result[0] contains "Interface IP Address S/L Description"', 'result[0] contains "--------- ---------- --- -----------"', 'result[0] contains "wg01 192.168.0.1/24 u/u VPN-to-Branch"']}) +2022-03-22 21:59:18,348 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] ********************************************************************************************************************************************************** +2022-03-22 21:59:18,373 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:59:18,374 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:18,382 p=88039 u=rob n=ansible | skipping: [central] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:59:18,383 p=88039 u=rob n=ansible | skipping: [central] => (item={'name': 'ping_branch_pc', 'command': 'ping 10.0.2.100 count 4'}) +2022-03-22 21:59:18,386 p=88039 u=rob n=ansible | skipping: [branch] => (item={'name': 'show_interfaces_wireguard', 'command': 'show interfaces wireguard'}) +2022-03-22 21:59:18,389 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:59:18,407 p=88039 u=rob n=ansible | skipping: [eveng] +2022-03-22 21:59:18,408 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:18,410 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:18,414 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:18,417 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output dir exist] ******************************************************************************************************************************************************** +2022-03-22 21:59:18,439 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:18,440 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:18,444 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:18,549 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:59:18,552 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output include dir exist] ************************************************************************************************************************************************ +2022-03-22 21:59:18,576 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:18,577 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:18,583 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:18,687 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:59:18,689 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Get timestamp from the system] ***************************************************************************************************************************************************** +2022-03-22 21:59:18,707 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:18,709 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:18,713 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:19,045 p=88039 u=rob n=ansible | changed: [eveng] +2022-03-22 21:59:19,049 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************************************************************************************* +2022-03-22 21:59:19,070 p=88039 u=rob n=ansible | ok: [eveng] +2022-03-22 21:59:19,077 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:19,078 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:19,082 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:19,086 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : generate lab rst file] ************************************************************************************************************************************************************* +2022-03-22 21:59:19,109 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:19,110 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:19,114 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:19,325 p=88039 u=rob n=ansible | changed: [eveng -> localhost] +2022-03-22 21:59:19,328 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.conf files in Lab] ****************************************************************************************************************************************************** +2022-03-22 21:59:19,350 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:19,352 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:19,356 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:19,516 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:59:19,524 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.conf files] ************************************************************************************************************************************************************* +2022-03-22 21:59:19,548 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:19,549 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:19,555 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:19,784 p=88039 u=rob n=ansible | changed: [eveng -> localhost] => (item={'path': 'labs/Wireguard/branch.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 694, 'inode': 43110473, 'dev': 16777234, 'nlink': 1, 'atime': 1647977709.7565134, 'mtime': 1647977709.2509136, 'ctime': 1647977709.2509136, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:59:19,997 p=88039 u=rob n=ansible | changed: [eveng -> localhost] => (item={'path': 'labs/Wireguard/central.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 687, 'inode': 43110474, 'dev': 16777234, 'nlink': 1, 'atime': 1647977709.7567177, 'mtime': 1647977709.251318, 'ctime': 1647977709.251318, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:59:20,001 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.png files in Lab] ******************************************************************************************************************************************************* +2022-03-22 21:59:20,023 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:20,024 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:20,028 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:20,126 p=88039 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-22 21:59:20,131 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.png files] ************************************************************************************************************************************************************** +2022-03-22 21:59:20,155 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:20,157 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:20,162 p=88039 u=rob n=ansible | skipping: [branch] +2022-03-22 21:59:20,413 p=88039 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/Wireguard/topology.png', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 158227, 'inode': 31651192, 'dev': 16777234, 'nlink': 1, 'atime': 1644943479.692409, 'mtime': 1637092135.8691404, 'ctime': 1637092174.4312608, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-22 21:59:20,418 p=88039 u=rob n=ansible | TASK [eve-ng-lab-test : copy ansible log files] ************************************************************************************************************************************************************ +2022-03-22 21:59:20,441 p=88039 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-22 21:59:20,442 p=88039 u=rob n=ansible | skipping: [central] +2022-03-22 21:59:20,446 p=88039 u=rob n=ansible | skipping: [branch] diff --git a/docs/configexamples/autotest/Wireguard/Wireguard.rst b/docs/configexamples/autotest/Wireguard/Wireguard.rst index efd0ac42..058536e7 100644 --- a/docs/configexamples/autotest/Wireguard/Wireguard.rst +++ b/docs/configexamples/autotest/Wireguard/Wireguard.rst @@ -3,8 +3,9 @@ Wireguard ######### -| Testdate: 2021-11-30 -| Version: 1.3.0-rc6 +| Testdate: 2022-03-22 +| Version: 1.3.1 +| Upgrade Version: 1.4-rolling-202203220701 This simple structure show how to connect two offices. One remote branch and the @@ -46,7 +47,7 @@ After this, the public key can be displayed, to save for later. vyos@central:~$ generate wireguard default-keypair vyos@central:~$ show wireguard keypairs pubkey default - EP6GX0Idw+mMlGUtvZheRR4FmYfxjb3a5GPiNVVf9yY= + OagNr7jAXSAvQlieqKAmcEH9+s+JfVOw5EdUroFudxA= After you have each public key. The wireguard interfaces can be setup. @@ -102,11 +103,11 @@ And ping the Branch PC from your central router to check the response. vyos@central:~$ ping 10.0.2.100 count 4 PING 10.0.2.100 (10.0.2.100) 56(84) bytes of data. - 64 bytes from 10.0.2.100: icmp_seq=1 ttl=63 time=0.727 ms - 64 bytes from 10.0.2.100: icmp_seq=2 ttl=63 time=0.712 ms - 64 bytes from 10.0.2.100: icmp_seq=3 ttl=63 time=0.913 ms - 64 bytes from 10.0.2.100: icmp_seq=4 ttl=63 time=0.792 ms + 64 bytes from 10.0.2.100: icmp_seq=1 ttl=63 time=0.593 ms + 64 bytes from 10.0.2.100: icmp_seq=2 ttl=63 time=0.672 ms + 64 bytes from 10.0.2.100: icmp_seq=3 ttl=63 time=0.828 ms + 64 bytes from 10.0.2.100: icmp_seq=4 ttl=63 time=0.667 ms --- 10.0.2.100 ping statistics --- - 4 packets transmitted, 4 received, 0% packet loss, time 48ms - rtt min/avg/max/mdev = 0.712/0.786/0.913/0.079 ms + 4 packets transmitted, 4 received, 0% packet loss, time 30ms + rtt min/avg/max/mdev = 0.593/0.690/0.828/0.085 ms diff --git a/docs/configexamples/autotest/Wireguard/_include/branch.conf b/docs/configexamples/autotest/Wireguard/_include/branch.conf index 7e0373ab..08259525 100644 --- a/docs/configexamples/autotest/Wireguard/_include/branch.conf +++ b/docs/configexamples/autotest/Wireguard/_include/branch.conf @@ -7,7 +7,7 @@ set interfaces wireguard wg01 peer central allowed-ips 10.0.1.0/24 set interfaces wireguard wg01 peer central allowed-ips 192.168.0.0/24 set interfaces wireguard wg01 peer central address 198.51.100.1 set interfaces wireguard wg01 peer central port 51820 -set interfaces wireguard wg01 peer central pubkey "EP6GX0Idw+mMlGUtvZheRR4FmYfxjb3a5GPiNVVf9yY=" +set interfaces wireguard wg01 peer central pubkey "OagNr7jAXSAvQlieqKAmcEH9+s+JfVOw5EdUroFudxA=" set interfaces wireguard wg01 port 51820 set protocols static interface-route 10.0.1.0/24 next-hop-interface wg01
\ No newline at end of file diff --git a/docs/configexamples/autotest/Wireguard/_include/central.conf b/docs/configexamples/autotest/Wireguard/_include/central.conf index 5bb5b496..30d3da49 100644 --- a/docs/configexamples/autotest/Wireguard/_include/central.conf +++ b/docs/configexamples/autotest/Wireguard/_include/central.conf @@ -7,7 +7,7 @@ set interfaces wireguard wg01 peer branch allowed-ips 10.0.2.0/24 set interfaces wireguard wg01 peer branch allowed-ips 192.168.0.0/24 set interfaces wireguard wg01 peer branch address 198.51.100.2 set interfaces wireguard wg01 peer branch port 51820 -set interfaces wireguard wg01 peer branch pubkey "QjQThdcp2F/pJEXQe4UfOCetML4MMP+aUrUZzjG44xA=" +set interfaces wireguard wg01 peer branch pubkey "PJls3F1FAHNmZJoGo1kFJIKDyWyT4pD0fneB0NdMTTg=" set interfaces wireguard wg01 port 51820 set protocols static interface-route 10.0.2.0/24 next-hop-interface wg01
\ No newline at end of file diff --git a/docs/configexamples/autotest/tunnelbroker/_include/client.conf b/docs/configexamples/autotest/tunnelbroker/_include/client.conf new file mode 100644 index 00000000..cedb1ab8 --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/_include/client.conf @@ -0,0 +1 @@ +set interfaces ethernet eth1 ipv6 address autoconf
\ No newline at end of file diff --git a/docs/configexamples/autotest/tunnelbroker/_include/topology.png b/docs/configexamples/autotest/tunnelbroker/_include/topology.png Binary files differnew file mode 100644 index 00000000..e70d55bc --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/_include/topology.png diff --git a/docs/configexamples/autotest/tunnelbroker/_include/transport.conf b/docs/configexamples/autotest/tunnelbroker/_include/transport.conf new file mode 100644 index 00000000..1ecebc61 --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/_include/transport.conf @@ -0,0 +1,2 @@ +set interfaces ethernet eth1 address '10.0.10.254/24' +set interfaces ethernet eth2 address '10.0.20.254/24'
\ No newline at end of file diff --git a/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan.conf b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan.conf new file mode 100644 index 00000000..86a563dc --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan.conf @@ -0,0 +1 @@ +set interfaces ethernet eth1 address dhcp diff --git a/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf new file mode 100644 index 00000000..97902208 --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf @@ -0,0 +1,13 @@ +set interfaces tunnel tun0 address '2001:470:6c:779::2/64' #Tunnelbroker Client IPv6 Address +set interfaces tunnel tun0 description 'HE.NET IPv6 Tunnel' +set interfaces tunnel tun0 encapsulation 'sit' +set interfaces tunnel tun0 remote '216.66.86.114' #Tunnelbroker Server IPv4 Address +set interfaces tunnel tun0 source-address '172.29.129.60' # Tunnelbroker Client IPv4 Address or if there is NAT the current WAN interface address + +set protocols static interface-route6 ::/0 next-hop-interface tun0 + +set interface ethernet eth2 address '2001:470:6d:778::1/64' # Tunnelbroker Routed /64 prefix +set service router-advert interface eth2 name-server '2001:470:20::2' +set service router-advert interface eth2 prefix 2001:470:6d:778::/64 # Tunnelbroker Routed /64 prefix + +set system name-server 2001:470:20::2 #Tunnelbroker DNS Server
\ No newline at end of file diff --git a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.log b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.log new file mode 100644 index 00000000..88f7c35a --- /dev/null +++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.log @@ -0,0 +1,593 @@ +2022-03-24 07:31:50,638 p=96019 u=rob n=ansible | PLAY [prepare node and Lab] ********************************************************************************************************* +2022-03-24 07:31:50,663 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : fail] **************************************************************************************************** +2022-03-24 07:31:50,689 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:50,696 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:50,697 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:50,701 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:50,704 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : fail] **************************************************************************************************** +2022-03-24 07:31:50,718 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:50,723 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:50,725 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:50,729 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:50,732 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************** +2022-03-24 07:31:50,755 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:50,759 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:50,764 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:52,006 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:52,011 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : get template facts] ************************************************************************************** +2022-03-24 07:31:52,039 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:52,040 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:52,046 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:52,586 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:52,591 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Register path status] ************************************************************************************ +2022-03-24 07:31:52,635 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:52,637 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:52,643 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,234 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:53,239 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : create path] ********************************************************************************************* +2022-03-24 07:31:53,261 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,269 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,270 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,274 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,278 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Download iso] ******************************************************************************************** +2022-03-24 07:31:53,293 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,301 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,301 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,305 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,309 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : create virtioa.qcow2 file] ******************************************************************************* +2022-03-24 07:31:53,322 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,329 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,331 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,333 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,336 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie] ************************************************************************** +2022-03-24 07:31:53,349 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,355 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,357 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,361 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,363 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : create lab for node install] ***************************************************************************** +2022-03-24 07:31:53,376 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,381 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,383 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,386 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,388 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : open lab] ************************************************************************************************ +2022-03-24 07:31:53,400 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,406 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,408 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,411 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,415 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] ************************************************************************************************ +2022-03-24 07:31:53,428 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,433 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,435 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,438 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,440 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : add node to lab] ***************************************************************************************** +2022-03-24 07:31:53,453 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,460 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,462 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,464 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,466 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : start node] ********************************************************************************************** +2022-03-24 07:31:53,477 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,483 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,485 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,488 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,490 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : get node infos] ****************************************************************************************** +2022-03-24 07:31:53,503 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,509 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,512 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,515 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,517 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : set_fact] ************************************************************************************************ +2022-03-24 07:31:53,531 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,537 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,538 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,542 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,545 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : copy file] *********************************************************************************************** +2022-03-24 07:31:53,559 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,564 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,566 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,569 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,571 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : run expect script] *************************************************************************************** +2022-03-24 07:31:53,584 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,589 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,592 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,596 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,598 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Login to EVE-NG and get Cookie (due timeout)] ************************************************************ +2022-03-24 07:31:53,611 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,616 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,618 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,621 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,623 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : stop node] *********************************************************************************************** +2022-03-24 07:31:53,634 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,640 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,642 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,645 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,648 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : Pause to wait node is shutdown] ************************************************************************** +2022-03-24 07:31:53,656 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,658 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : delete iso] ********************************************************************************************** +2022-03-24 07:31:53,671 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,676 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,678 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,681 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,683 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : commit virtioa.qcow2] ************************************************************************************ +2022-03-24 07:31:53,695 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,701 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,703 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,705 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,708 p=96019 u=rob n=ansible | TASK [eve-ng-create-node : delete lab for node install] ***************************************************************************** +2022-03-24 07:31:53,720 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:53,726 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:53,728 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:53,731 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:53,738 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Get env file content] *************************************************************************************** +2022-03-24 07:31:53,951 p=96019 u=rob n=ansible | ok: [vyos-wan -> localhost] +2022-03-24 07:31:53,951 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:31:53,951 p=96019 u=rob n=ansible | ok: [client -> localhost] +2022-03-24 07:31:53,953 p=96019 u=rob n=ansible | ok: [vyos-oobm -> localhost] +2022-03-24 07:31:53,954 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Load facts] ************************************************************************************************* +2022-03-24 07:31:53,979 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:53,980 p=96019 u=rob n=ansible | ok: [vyos-oobm] +2022-03-24 07:31:54,870 p=96278 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:31:54,870 p=96279 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:31:54,878 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:31:54,878 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:31:54,884 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : fail] ******************************************************************************************************* +2022-03-24 07:31:54,907 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:54,917 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:54,918 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:54,924 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:54,927 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:31:54,948 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:54,950 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:54,954 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:55,571 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:55,576 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : get running lab list] *************************************************************************************** +2022-03-24 07:31:55,604 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:55,606 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:55,611 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:56,078 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:56,083 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : delete existing lab] **************************************************************************************** +2022-03-24 07:31:56,111 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:56,113 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:56,119 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:56,699 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:56,706 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Ensure labtest is present] ********************************************************************************** +2022-03-24 07:31:56,733 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:56,734 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:56,741 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:57,057 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:57,061 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Create tunnelbroker Lab] ************************************************************************************ +2022-03-24 07:31:57,082 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:57,084 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:57,088 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:57,762 p=96019 u=rob n=ansible | changed: [eveng] +2022-03-24 07:31:57,766 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:31:57,788 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:57,789 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:57,794 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:58,416 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:58,421 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : start vyos-oobm] ******************************************************************************************** +2022-03-24 07:31:58,449 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:31:58,451 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:58,456 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:31:59,364 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:31:59,371 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos-oobm] ***************************************************************************************** +2022-03-24 07:31:59,390 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:31:59,400 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:31:59,406 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:32:49,434 p=96019 u=rob n=ansible | ok: [vyos-oobm] +2022-03-24 07:32:49,440 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:32:49,468 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:32:49,470 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:32:49,476 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:32:50,146 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:32:50,152 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : get lab status] ********************************************************************************************* +2022-03-24 07:32:50,179 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:32:50,182 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:32:50,187 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:32:50,645 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:32:50,650 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : start all nodes] ******************************************************************************************** +2022-03-24 07:32:50,678 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:32:50,680 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:32:50,686 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:32:51,553 p=96019 u=rob n=ansible | ok: [eveng] => (item=4) +2022-03-24 07:32:52,055 p=96019 u=rob n=ansible | ok: [eveng] => (item=1) +2022-03-24 07:32:52,954 p=96019 u=rob n=ansible | ok: [eveng] => (item=2) +2022-03-24 07:32:52,961 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] **************************************************************************************** +2022-03-24 07:32:52,980 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:32:52,987 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:33:08,868 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Exception: Error reading SSH protocol banner +2022-03-24 07:33:08,871 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:08,871 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-24 07:33:08,871 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf = self.packetizer.readline(timeout) +2022-03-24 07:33:08,871 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-24 07:33:08,871 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Exception: Error reading SSH protocol banner +2022-03-24 07:33:08,871 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf += self._read_timeout(timeout) +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise socket.timeout() +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | socket.timeout +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | During handling of the above exception, another exception occurred: +2022-03-24 07:33:08,872 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Traceback (most recent call last): +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:08,872 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:08,872 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | buf = self.packetizer.readline(timeout) +2022-03-24 07:33:08,872 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-24 07:33:08,872 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-24 07:33:08,873 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | self._check_banner() +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | buf += self._read_timeout(timeout) +2022-03-24 07:33:08,873 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-24 07:33:08,873 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise SSHException( +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | raise socket.timeout() +2022-03-24 07:33:08,873 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | socket.timeout +2022-03-24 07:33:08,873 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | During handling of the above exception, another exception occurred: +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:08,873 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Traceback (most recent call last): +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | self._check_banner() +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | raise SSHException( +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-24 07:33:08,874 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:24,899 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Exception: Error reading SSH protocol banner +2022-03-24 07:33:24,900 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Traceback (most recent call last): +2022-03-24 07:33:24,900 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-24 07:33:24,900 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | buf = self.packetizer.readline(timeout) +2022-03-24 07:33:24,900 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-24 07:33:24,900 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | buf += self._read_timeout(timeout) +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | raise socket.timeout() +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | socket.timeout +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | During handling of the above exception, another exception occurred: +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Traceback (most recent call last): +2022-03-24 07:33:24,901 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-24 07:33:24,902 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | self._check_banner() +2022-03-24 07:33:24,902 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-24 07:33:24,902 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | raise SSHException( +2022-03-24 07:33:24,902 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-24 07:33:24,902 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | +2022-03-24 07:33:24,904 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Exception: Error reading SSH protocol banner +2022-03-24 07:33:24,905 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:24,905 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-24 07:33:24,905 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf = self.packetizer.readline(timeout) +2022-03-24 07:33:24,905 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-24 07:33:24,905 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf += self._read_timeout(timeout) +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise socket.timeout() +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | socket.timeout +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | During handling of the above exception, another exception occurred: +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:24,906 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-24 07:33:24,907 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | self._check_banner() +2022-03-24 07:33:24,907 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-24 07:33:24,907 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise SSHException( +2022-03-24 07:33:24,907 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-24 07:33:24,907 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:26,730 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:33:26,782 p=96552 u=rob n=p=96552 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:33:27,599 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:33:40,931 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Exception: Error reading SSH protocol banner +2022-03-24 07:33:40,932 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:40,932 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2211, in _check_banner +2022-03-24 07:33:40,932 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf = self.packetizer.readline(timeout) +2022-03-24 07:33:40,932 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 380, in readline +2022-03-24 07:33:40,932 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | buf += self._read_timeout(timeout) +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/packet.py", line 622, in _read_timeout +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise socket.timeout() +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | socket.timeout +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | During handling of the above exception, another exception occurred: +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Traceback (most recent call last): +2022-03-24 07:33:40,933 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2039, in run +2022-03-24 07:33:40,934 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | self._check_banner() +2022-03-24 07:33:40,934 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | File "/Users/rob/.local/share/virtualenvs/vyos-eveng-b9X2mBdh/lib/python3.9/site-packages/paramiko/transport.py", line 2215, in _check_banner +2022-03-24 07:33:40,934 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | raise SSHException( +2022-03-24 07:33:40,934 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | paramiko.ssh_exception.SSHException: Error reading SSH protocol banner +2022-03-24 07:33:40,934 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | +2022-03-24 07:33:42,491 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:33:42,574 p=96553 u=rob n=p=96553 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:33:43,489 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:33:43,491 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : include tunnelbroker lab_config.yml] ************************************************************************ +2022-03-24 07:33:43,505 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:33:43,511 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:33:43,523 p=96019 u=rob n=ansible | included: /Users/rob/git/_vyos/vyos-eveng/labs/tunnelbroker/lab_config.yml for vyos-wan, client +2022-03-24 07:33:43,549 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : setup nodes] ************************************************************************************************ +2022-03-24 07:33:45,245 p=96286 u=rob n=p=96286 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:33:45,245 p=96287 u=rob n=p=96287 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:33:45,328 p=96286 u=rob n=p=96286 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:33:45,329 p=96287 u=rob n=p=96287 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:33:49,444 p=96019 u=rob n=ansible | [WARNING]: To ensure idempotency and correct diff the input configuration lines should be similar to how they appear if present in +the running configuration on device including the indentation + +2022-03-24 07:33:49,444 p=96019 u=rob n=ansible | changed: [client] +2022-03-24 07:33:49,459 p=96019 u=rob n=ansible | changed: [vyos-wan] +2022-03-24 07:33:49,466 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Register external IP in Tunnelbroker] *********************************************************************** +2022-03-24 07:33:49,483 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:33:51,042 p=96019 u=rob n=ansible | ok: [vyos-wan -> eveng] +2022-03-24 07:33:51,051 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : get ipv4 address of vyos-wan (eth1)] ************************************************************************ +2022-03-24 07:33:51,072 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:33:52,259 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:33:52,265 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************** +2022-03-24 07:33:52,279 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:33:53,132 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:33:53,144 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : setup vyos-wan] ********************************************************************************************* +2022-03-24 07:33:53,166 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:33:59,306 p=96019 u=rob n=ansible | changed: [vyos-wan] +2022-03-24 07:33:59,310 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:33:59,336 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:33:59,338 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:33:59,344 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:33:59,960 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:33:59,966 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************** +2022-03-24 07:34:00,009 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************** +2022-03-24 07:34:00,018 p=96724 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:34:00,018 p=96724 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:34:05,028 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:34:05,036 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ********************************************************************************************* +2022-03-24 07:34:05,086 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ******************************************************************************************* +2022-03-24 07:34:05,095 p=96729 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:34:05,095 p=96729 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:34:10,101 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:34:10,108 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ****************************************************** +2022-03-24 07:34:10,123 p=96731 u=rob n=ansible | Pausing for 30 seconds +2022-03-24 07:34:10,123 p=96731 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:34:40,130 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:34:40,136 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] *********************************************************************************************** +2022-03-24 07:34:40,158 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:40,168 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:45,571 p=96019 u=rob n=ansible | ok: [client] => (item=2001:470:20::2) +2022-03-24 07:34:45,751 p=96019 u=rob n=ansible | ok: [vyos-wan] => (item=tunnelbroker.net) +2022-03-24 07:34:45,755 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************** +2022-03-24 07:34:45,779 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:45,780 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:45,782 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:34:45,788 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:34:45,791 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] *********************************************************************************** +2022-03-24 07:34:45,811 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:45,811 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:50,061 p=96019 u=rob n=ansible | ok: [client] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:34:50,062 p=96019 u=rob n=ansible | ok: [vyos-wan] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:34:53,674 p=96019 u=rob n=ansible | ok: [vyos-wan] => (item={'name': 'ping_name', 'command': 'ping tunnelbroker.net count 4'}) +2022-03-24 07:34:53,679 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************** +2022-03-24 07:34:53,696 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:53,703 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:54,551 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:34:54,552 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:34:54,558 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] ************************************************************************************************ +2022-03-24 07:34:54,583 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:54,590 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:55,824 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:34:55,825 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:34:55,828 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] **************************************************************************************** +2022-03-24 07:34:55,840 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:55,843 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] **************************************************************************************** +2022-03-24 07:34:55,859 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:34:55,865 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:34:57,393 p=96887 u=rob n=p=96887 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:34:57,393 p=96886 u=rob n=p=96886 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:34:57,480 p=96887 u=rob n=p=96887 u=rob | paramiko [client] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-24 07:34:57,566 p=96886 u=rob n=p=96886 u=rob | paramiko [vyos-wan] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-24 07:36:56,070 p=96286 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-24 07:36:56,071 p=96287 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-24 07:36:56,174 p=96287 u=rob n=ansible | shutdown complete +2022-03-24 07:36:56,174 p=96286 u=rob n=ansible | shutdown complete +2022-03-24 07:36:58,964 p=96887 u=rob n=p=96887 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:36:58,965 p=96886 u=rob n=p=96886 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:36:59,039 p=96887 u=rob n=p=96887 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:36:59,108 p=96886 u=rob n=p=96886 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:37:00,138 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:37:00,204 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:37:00,206 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:37:00,225 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:00,227 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:00,231 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:01,066 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:37:01,073 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************** +2022-03-24 07:37:01,119 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************** +2022-03-24 07:37:01,128 p=97007 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:37:01,129 p=97007 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:37:06,138 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:37:06,150 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ********************************************************************************************* +2022-03-24 07:37:06,211 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ******************************************************************************************* +2022-03-24 07:37:06,220 p=97015 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:37:06,221 p=97015 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:37:11,227 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:37:11,240 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ****************************************************** +2022-03-24 07:37:11,258 p=97021 u=rob n=ansible | Pausing for 30 seconds +2022-03-24 07:37:11,258 p=97021 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:37:41,265 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:37:41,278 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] *********************************************************************************************** +2022-03-24 07:37:41,308 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:37:41,319 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:42,197 p=97029 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:37:42,197 p=97030 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:37:43,312 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:43,312 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:43,405 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:37:43,444 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:37:49,398 p=96019 u=rob n=ansible | ok: [client] => (item=2001:470:20::2) +2022-03-24 07:37:49,659 p=96019 u=rob n=ansible | ok: [vyos-wan] => (item=tunnelbroker.net) +2022-03-24 07:37:49,664 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************** +2022-03-24 07:37:49,688 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:37:49,688 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:49,692 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:49,698 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:49,700 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] *********************************************************************************** +2022-03-24 07:37:49,720 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:37:49,720 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:49,727 p=96019 u=rob n=ansible | skipping: [vyos-wan] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:37:49,728 p=96019 u=rob n=ansible | skipping: [vyos-wan] => (item={'name': 'ping_name', 'command': 'ping tunnelbroker.net count 4'}) +2022-03-24 07:37:49,731 p=96019 u=rob n=ansible | skipping: [client] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:37:49,734 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************** +2022-03-24 07:37:49,753 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:37:49,754 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:49,756 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:49,760 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:49,763 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : make sure tmp dir exist] ************************************************************************************ +2022-03-24 07:37:49,787 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:49,788 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:49,792 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:49,954 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:37:49,957 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : register status of tmp/vyos-1.4-rolling-202203220701-amd64.iso] ********************************************* +2022-03-24 07:37:49,977 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:49,979 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:49,983 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:50,233 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:37:50,238 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Download upgrade_iso] *************************************************************************************** +2022-03-24 07:37:50,268 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:50,269 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:37:50,274 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:37:51,127 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:37:51,133 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Copy iso to host] ******************************************************************************************* +2022-03-24 07:37:51,149 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:37:51,156 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:37:52,657 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:52,675 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:52,756 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:37:52,786 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:37:53,597 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:53,615 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:37:53,691 p=97038 u=rob n=p=97038 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:37:53,736 p=97037 u=rob n=p=97037 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:38:44,593 p=96019 u=rob n=ansible | changed: [client] +2022-03-24 07:38:44,777 p=96019 u=rob n=ansible | changed: [vyos-wan] +2022-03-24 07:38:44,781 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : upgrade vyos] *********************************************************************************************** +2022-03-24 07:38:44,805 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:38:44,814 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:38:54,957 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:38:55,104 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:38:55,108 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Reboot vyos] ************************************************************************************************ +2022-03-24 07:38:55,125 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:38:55,133 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:38:56,598 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:38:56,607 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:38:56,611 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait while shutdown] **************************************************************************************** +2022-03-24 07:38:56,622 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:38:56,625 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Wait for vyos nodes] **************************************************************************************** +2022-03-24 07:38:56,640 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:38:56,646 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:38:58,309 p=97262 u=rob n=p=97262 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:38:58,320 p=97263 u=rob n=p=97263 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_7.9p1) +2022-03-24 07:38:58,414 p=97263 u=rob n=p=97263 u=rob | paramiko [client] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-24 07:38:58,475 p=97262 u=rob n=p=97262 u=rob | paramiko [vyos-wan] | Auth banner: b'System is going down. Unprivileged users are not permitted to log in anymore. For technical details, see pam_nologin(8).\n\n' +2022-03-24 07:40:56,853 p=97037 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-24 07:40:56,857 p=97038 u=rob n=ansible | persistent connection idle timeout triggered, timeout value is 120 secs. +See the timeout setting options in the Network Debug and Troubleshooting Guide. +2022-03-24 07:40:56,958 p=97037 u=rob n=ansible | shutdown complete +2022-03-24 07:40:56,960 p=97038 u=rob n=ansible | shutdown complete +2022-03-24 07:41:00,117 p=97262 u=rob n=p=97262 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-24 07:41:00,117 p=97263 u=rob n=p=97263 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-24 07:41:00,179 p=97263 u=rob n=p=97263 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:41:00,233 p=97262 u=rob n=p=97262 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:41:01,425 p=96019 u=rob n=ansible | ok: [client] +2022-03-24 07:41:01,471 p=96019 u=rob n=ansible | ok: [vyos-wan] +2022-03-24 07:41:01,473 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : clear tmp dir] ********************************************************************************************** +2022-03-24 07:41:01,482 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:41:01,484 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Login to EVE-NG and get Cookie] ***************************************************************************** +2022-03-24 07:41:01,503 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:01,505 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:01,509 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:02,325 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:41:02,330 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : stop nodes id] ********************************************************************************************** +2022-03-24 07:41:02,373 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after stop] ******************************************************************************************** +2022-03-24 07:41:02,382 p=97355 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:41:02,383 p=97355 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:41:07,391 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:41:07,397 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : start nodes id] ********************************************************************************************* +2022-03-24 07:41:07,447 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait after start] ******************************************************************************************* +2022-03-24 07:41:07,457 p=97360 u=rob n=ansible | Pausing for 5 seconds +2022-03-24 07:41:07,458 p=97360 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:41:12,465 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:41:12,471 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : wait, b/c the ping often failed without a short break] ****************************************************** +2022-03-24 07:41:12,488 p=97362 u=rob n=ansible | Pausing for 30 seconds +2022-03-24 07:41:12,488 p=97362 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2022-03-24 07:41:42,496 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:41:42,503 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : do ping test] *********************************************************************************************** +2022-03-24 07:41:42,535 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:41:42,538 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:43,421 p=97370 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:41:43,421 p=97371 u=rob n=ansible | network_os is set to vyos +2022-03-24 07:41:44,102 p=97378 u=rob n=p=97378 u=rob | paramiko [client] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-24 07:41:44,105 p=97379 u=rob n=p=97379 u=rob | paramiko [vyos-wan] | Connected (version 2.0, client OpenSSH_8.4p1) +2022-03-24 07:41:44,186 p=97378 u=rob n=p=97378 u=rob | paramiko [client] | Authentication (publickey) successful! +2022-03-24 07:41:44,250 p=97379 u=rob n=p=97379 u=rob | paramiko [vyos-wan] | Authentication (publickey) successful! +2022-03-24 07:41:49,938 p=96019 u=rob n=ansible | ok: [client] => (item=2001:470:20::2) +2022-03-24 07:41:50,247 p=96019 u=rob n=ansible | ok: [vyos-wan] => (item=tunnelbroker.net) +2022-03-24 07:41:50,253 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : execute test commands] ************************************************************************************** +2022-03-24 07:41:50,278 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:41:50,286 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,292 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:50,299 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:50,302 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : register stdout commands] *********************************************************************************** +2022-03-24 07:41:50,325 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:41:50,327 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,336 p=96019 u=rob n=ansible | skipping: [vyos-wan] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:41:50,337 p=96019 u=rob n=ansible | skipping: [vyos-wan] => (item={'name': 'ping_name', 'command': 'ping tunnelbroker.net count 4'}) +2022-03-24 07:41:50,341 p=96019 u=rob n=ansible | skipping: [client] => (item={'name': 'ping_ip', 'command': 'ping 2001:470:20::2 count 4'}) +2022-03-24 07:41:50,344 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************** +2022-03-24 07:41:50,365 p=96019 u=rob n=ansible | skipping: [eveng] +2022-03-24 07:41:50,367 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,367 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:50,373 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:50,378 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output dir exist] ********************************************************************************* +2022-03-24 07:41:50,402 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,403 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:50,408 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:50,522 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:41:50,525 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : make sure output include dir exist] ************************************************************************* +2022-03-24 07:41:50,550 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,551 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:50,555 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:50,663 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:41:50,666 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Get timestamp from the system] ****************************************************************************** +2022-03-24 07:41:50,686 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:50,687 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:50,691 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:51,029 p=96019 u=rob n=ansible | changed: [eveng] +2022-03-24 07:41:51,033 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : Set variables] ********************************************************************************************** +2022-03-24 07:41:51,058 p=96019 u=rob n=ansible | ok: [eveng] +2022-03-24 07:41:51,060 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:51,060 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:51,064 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:51,068 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : generate lab rst file] ************************************************************************************** +2022-03-24 07:41:51,092 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:51,093 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:51,097 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:51,312 p=96019 u=rob n=ansible | changed: [eveng -> localhost] +2022-03-24 07:41:51,316 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.conf files in Lab] ******************************************************************************* +2022-03-24 07:41:51,341 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:51,342 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:51,348 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:51,533 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:41:51,543 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.conf files] ************************************************************************************** +2022-03-24 07:41:51,570 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:51,571 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:51,577 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:51,853 p=96019 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/tunnelbroker/vyos-wan_tun0.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 950, 'inode': 43110475, 'dev': 16777234, 'nlink': 1, 'atime': 1647977709.6739101, 'mtime': 1647977709.2516916, 'ctime': 1647977709.2516916, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-24 07:41:52,073 p=96019 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/tunnelbroker/client.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 50, 'inode': 36962831, 'dev': 16777234, 'nlink': 1, 'atime': 1640860062.1877348, 'mtime': 1640860060.221699, 'ctime': 1640860060.221699, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-24 07:41:52,313 p=96019 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/tunnelbroker/vyos-wan.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 42, 'inode': 36962838, 'dev': 16777234, 'nlink': 1, 'atime': 1640860060.885441, 'mtime': 1640860060.2232249, 'ctime': 1640860060.2232249, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-24 07:41:52,528 p=96019 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/tunnelbroker/transport.conf', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 107, 'inode': 36962835, 'dev': 16777234, 'nlink': 1, 'atime': 1640860060.8872008, 'mtime': 1640860060.2225564, 'ctime': 1640860060.2225564, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-24 07:41:52,533 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : find all *.png files in Lab] ******************************************************************************** +2022-03-24 07:41:52,557 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:52,558 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:52,564 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:52,660 p=96019 u=rob n=ansible | ok: [eveng -> localhost] +2022-03-24 07:41:52,664 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : copy all *.png files] *************************************************************************************** +2022-03-24 07:41:52,690 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:52,692 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:52,697 p=96019 u=rob n=ansible | skipping: [client] +2022-03-24 07:41:52,887 p=96019 u=rob n=ansible | ok: [eveng -> localhost] => (item={'path': 'labs/tunnelbroker/topology.png', 'mode': '0644', 'isdir': False, 'ischr': False, 'isblk': False, 'isreg': True, 'isfifo': False, 'islnk': False, 'issock': False, 'uid': 501, 'gid': 20, 'size': 34614, 'inode': 36962834, 'dev': 16777234, 'nlink': 1, 'atime': 1640860570.2552865, 'mtime': 1640860060.2223997, 'ctime': 1640860060.2223997, 'gr_name': 'staff', 'pw_name': 'rob', 'wusr': True, 'rusr': True, 'xusr': False, 'wgrp': False, 'rgrp': True, 'xgrp': False, 'woth': False, 'roth': True, 'xoth': False, 'isuid': False, 'isgid': False}) +2022-03-24 07:41:52,892 p=96019 u=rob n=ansible | TASK [eve-ng-lab-test : copy ansible log files] ************************************************************************************* +2022-03-24 07:41:52,915 p=96019 u=rob n=ansible | skipping: [vyos-oobm] +2022-03-24 07:41:52,916 p=96019 u=rob n=ansible | skipping: [vyos-wan] +2022-03-24 07:41:52,920 p=96019 u=rob n=ansible | skipping: [client] diff --git a/docs/configexamples/tunnelbroker-ipv6.rst b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst index 08cba5cc..2fd70c17 100644 --- a/docs/configexamples/tunnelbroker-ipv6.rst +++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst @@ -1,13 +1,13 @@ -:lastproofread: 2021-06-29 - .. _examples-tunnelbroker-ipv6: -.. stop_vyoslinter - ####################### Tunnelbroker.net (IPv6) ####################### +| Testdate: 2022-03-24 +| Version: 1.3.1 +| Upgrade Version: 1.4-rolling-202203220701 + This guide walks through the setup of https://www.tunnelbroker.net/ for an IPv6 Tunnel. @@ -21,69 +21,84 @@ Prerequisites - Requested a "Regular Tunnel". You want to choose a location that is closest to your physical location for the best response time. -Setup initial tunnel -==================== -Set up initial IPv6 tunnel. Replace the field below from the fields on the -tunnel information page. +******** +Topology +******** -.. code-block:: none +The example topology has 2 VyOS routers. One as The WAN Router and on as a +Client, to test a single LAN setup - conf - set interfaces tunnel tun0 address Client_IPv6_from_Tunnelbroker # This will be your VyOS install's public IPv6 address - set interfaces tunnel tun0 description 'HE.NET IPv6 Tunnel' - set interfaces tunnel tun0 encapsulation 'sit' - set interfaces tunnel tun0 source-address Client_IPv4_from_Tunnelbroker # This is your public IP - set interfaces tunnel tun0 mtu '1472' - set interfaces tunnel tun0 multicast 'disable' - set interfaces tunnel tun0 remote Server_IPv4_from_Tunnelbroker # This is the IP of the Tunnelbroker server - set protocols static interface-route6 ::/0 next-hop-interface tun0 # Tell all traffic to go over this tunnel - commit +.. image:: _include/topology.png + :alt: Tunnelbroker topology image -If your WAN connection is over PPPoE, you may need to set the MTU on the above -tunnel lower than 1472. -At this point you should be able to ping an IPv6 address, try pinging Google: +************* +Configuration +************* -.. code-block:: none +First, we configure the ``vyos-wan`` interface to get a DHCP address. - ping6 -c2 2001:4860:4860::8888 +.. literalinclude:: _include/vyos-wan.conf + :language: none - 64 bytes from 2001:4860:4860::8888: icmp_seq=1 ttl=57 time=21.7 ms - 64 bytes from 2001:4860:4860::8888: icmp_seq=2 ttl=57 time=21.1 ms - --- 2001:4860:4860::8888 ping statistics --- - 2 packets transmitted, 2 received, 0% packet loss, time 1001ms - rtt min/avg/max/mdev = 21.193/21.459/21.726/0.304 ms +Now we are able to setup the tunnel interface. + +.. literalinclude:: _include/vyos-wan_tun0.conf + :language: none + :lines: 1-5 + +Setup the ipv6 default route to the tunnel interface + +.. literalinclude:: _include/vyos-wan_tun0.conf + :language: none + :lines: 7 + +Now you should be able to ping a public IPv6 Address -Assuming the pings are successful, you need to add some DNS servers. -Some options: .. code-block:: none - set system name-server 2001:4860:4860::8888 # Google - set system name-server 2001:4860:4860::8844 # Google - set system name-server 2606:4700:4700::1111 # Cloudflare - set system name-server 2606:4700:4700::1001 # Cloudflare - commit + vyos@vyos-wan:~$ ping 2001:470:20::2 count 4 + PING 2001:470:20::2(2001:470:20::2) 56 data bytes + 64 bytes from 2001:470:20::2: icmp_seq=1 ttl=64 time=30.7 ms + 64 bytes from 2001:470:20::2: icmp_seq=2 ttl=64 time=29.8 ms + 64 bytes from 2001:470:20::2: icmp_seq=3 ttl=64 time=30.1 ms + 64 bytes from 2001:470:20::2: icmp_seq=4 ttl=64 time=30.2 ms + + --- 2001:470:20::2 ping statistics --- + 4 packets transmitted, 4 received, 0% packet loss, time 9ms + rtt min/avg/max/mdev = 29.765/30.171/30.673/0.389 ms + + +Assuming the pings are successful, you need to add some DNS servers. +Some options: + +.. literalinclude:: _include/vyos-wan_tun0.conf + :language: none + :lines: 13 You should now be able to ping something by IPv6 DNS name: -.. code-block:: none - # ping6 -c2 one.one.one.one - PING one.one.one.one(one.one.one.one) 56 data bytes - 64 bytes from one.one.one.one: icmp_seq=1 ttl=58 time=16.8 ms - 64 bytes from one.one.one.one: icmp_seq=2 ttl=58 time=17.4 ms +.. code-block:: none - --- one.one.one.one ping statistics --- - 2 packets transmitted, 2 received, 0% packet loss, time 1001ms - rtt min/avg/max/mdev = 16.880/17.153/17.426/0.273 ms + vyos@vyos-wan:~$ ping tunnelbroker.net count 4 + PING tunnelbroker.net(tunnelbroker.net (2001:470:0:63::2)) 56 data bytes + 64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=1 ttl=54 time=179 ms + 64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=2 ttl=54 time=227 ms + 64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=3 ttl=54 time=179 ms + 64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=4 ttl=54 time=179 ms + + --- tunnelbroker.net ping statistics --- + 4 packets transmitted, 4 received, 0% packet loss, time 8ms + rtt min/avg/max/mdev = 178.994/191.062/226.756/20.612 ms -Assuming everything works, you can proceed to the client configuration +***************** LAN Configuration -================= +***************** At this point, your VyOS install should have full IPv6, but now your LAN devices need access. @@ -92,32 +107,34 @@ With Tunnelbroker.net, you have two options: - Routed /64. This is the default assignment. In IPv6-land, it's good for a single "LAN", and is somewhat equivalent to a /24. - Example: `2001:470:xxxx:xxxx::/64` + - Routed /48. This is something you can request by clicking the "Assign /48" link in the Tunnelbroker.net tunnel config. It allows you to have up to 65k - LANs. Example: `2001:470:xxxx::/48` Unlike IPv4, IPv6 is really not designed to be broken up smaller than /64. So if you ever want to have multiple LANs, VLANs, DMZ, etc, you'll want to ignore the assigned /64, and request the /48 and use that. + Single LAN Setup ================ -Single LAN setup where eth1 is your LAN interface. Use the /64 (all the xxxx -should be replaced with the information from your `Routed /64` tunnel): +Single LAN setup where eth2 is your LAN interface. Use the Tunnelbroker +Routed /64 prefix: -.. code-block:: none - - set interfaces ethernet eth1 address '2001:470:xxxx:xxxx::1/64' - set service router-advert interface eth1 name-server '2001:4860:4860::8888' - set service router-advert interface eth1 name-server '2001:4860:4860::8844' - set service router-advert interface eth1 prefix 2001:470:xxxx:xxxx::/64 +.. literalinclude:: _include/vyos-wan_tun0.conf + :language: none + :lines: 9-11 Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default, 'valid-lifetime' and 'preferred-lifetime' are set to default values of 30 days and 4 hours respectively. +And the ``client`` to receive an IPv6 address with stateless autoconfig. + +.. literalinclude:: _include/client.conf + :language: none + This accomplishes a few things: - Sets your LAN interface's IP address @@ -125,10 +142,28 @@ This accomplishes a few things: DHCPv6 can still be used). With RAs, Your devices will automatically find the information they need for routing and DNS. +Now the Client is able to ping a public IPv6 address + + +.. code-block:: none + + vyos@client:~$ ping 2001:470:20::2 count 4 + PING 2001:470:20::2(2001:470:20::2) 56 data bytes + 64 bytes from 2001:470:20::2: icmp_seq=1 ttl=63 time=30.6 ms + 64 bytes from 2001:470:20::2: icmp_seq=2 ttl=63 time=30.4 ms + 64 bytes from 2001:470:20::2: icmp_seq=3 ttl=63 time=30.5 ms + 64 bytes from 2001:470:20::2: icmp_seq=4 ttl=63 time=30.6 ms + + --- 2001:470:20::2 ping statistics --- + 4 packets transmitted, 4 received, 0% packet loss, time 9ms + rtt min/avg/max/mdev = 30.387/30.537/30.643/0.238 ms + + Multiple LAN/DMZ Setup ====================== -In this, you use the `Routed /48` information. This allows you to assign a +That's how you can expand the example above. +Use the `Routed /48` information. This allows you to assign a different /64 to every interface, LAN, or even device. Or you could break your network into smaller chunks like /56 or /60. @@ -147,18 +182,15 @@ So, when your LAN is eth1, your DMZ is eth2, your cameras are on eth3, etc: .. code-block:: none set interfaces ethernet eth1 address '2001:470:xxxx:1::1/64' - set service router-advert interface eth1 name-server '2001:4860:4860::8888' - set service router-advert interface eth1 name-server '2001:4860:4860::8844' + set service router-advert interface eth1 name-server '2001:470:20::2' set service router-advert interface eth1 prefix 2001:470:xxxx:1::/64 set interfaces ethernet eth2 address '2001:470:xxxx:2::1/64' - set service router-advert interface eth2 name-server '2001:4860:4860::8888' - set service router-advert interface eth2 name-server '2001:4860:4860::8844' + set service router-advert interface eth2 name-server '2001:470:20::2' set service router-advert interface eth2 prefix 2001:470:xxxx:2::/64 set interfaces ethernet eth3 address '2001:470:xxxx:3::1/64' - set service router-advert interface eth3 name-server '2001:4860:4860::8888' - set service router-advert interface eth3 name-server '2001:4860:4860::8844' + set service router-advert interface eth3 name-server '2001:470:20::2' set service router-advert interface eth3 prefix 2001:470:xxxx:3::/64 Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default, @@ -174,7 +206,4 @@ NAME`. Similarly, to attach the firewall, you would use `set interfaces ethernet eth0 firewall in ipv6-name` or `set zone-policy zone LOCAL from WAN firewall -ipv6-name`. - - -.. start_vyoslinter +ipv6-name`.
\ No newline at end of file diff --git a/docs/configexamples/dhcp-relay-through-gre-bridge.rst b/docs/configexamples/dhcp-relay-through-gre-bridge.rst deleted file mode 100644 index ba37ba41..00000000 --- a/docs/configexamples/dhcp-relay-through-gre-bridge.rst +++ /dev/null @@ -1,78 +0,0 @@ -:lastproofread: 2021-06-28 - -.. _examples-dhcp-relay-through-gre-bridge: - - -DHCP Relay through GRE-Bridge ------------------------------ - -Diagram -^^^^^^^ - -.. image:: /_static/images/dhcp-relay-through-gre-bridge.png - :width: 80% - :align: center - :alt: Network Topology Diagram - -Configuration -^^^^^^^^^^^^^ - -DHCP Server -""""""""""" - -.. code-block:: none - - set interfaces ethernet eth0 address '10.0.2.1/24' - set interfaces loopback lo address '192.168.3.3/24' - set interfaces tunnel tun100 address '172.16.0.2/30' - set interfaces tunnel tun100 encapsulation 'gre-bridge' - set interfaces tunnel tun100 source-address '10.0.2.1' - set interfaces tunnel tun100 remote '192.168.0.1' - set protocols ospf area 0 network '192.168.3.0/24' - set protocols ospf area 0 network '10.0.2.0/24' - set protocols ospf parameters router-id '192.168.3.3' - set protocols static interface-route 10.0.1.2/32 next-hop-interface tun100 - set service dhcp-server shared-network-name asdf authoritative - set service dhcp-server shared-network-name asdf subnet 192.168.3.0/24 range 0 start '192.168.3.30' - set service dhcp-server shared-network-name asdf subnet 192.168.3.0/24 range 0 stop '192.168.3.40' - set service dhcp-server shared-network-name asdf subnet 10.0.1.0/24 default-router '10.0.1.2' - set service dhcp-server shared-network-name asdf subnet 10.0.1.0/24 range 0 start '10.0.1.200' - set service dhcp-server shared-network-name asdf subnet 10.0.1.0/24 range 0 stop '10.0.1.210' - set service dhcp-server shared-network-name asdf subnet 10.2.1.0/24 range 0 start '10.2.1.222' - set service dhcp-server shared-network-name asdf subnet 10.2.1.0/24 range 0 stop '10.2.1.233' - set service dhcp-server shared-network-name asdf subnet 172.16.0.0/30 range 0 start '172.16.0.1' - set service dhcp-server shared-network-name asdf subnet 172.16.0.0/30 range 0 stop '172.16.0.2' - - -In-Between Router -""""""""""""""""" - -.. code-block:: none - - set interfaces ethernet eth0 address '192.168.0.2/24' - set interfaces ethernet eth1 address '10.0.2.2/24' - set protocols ospf area 0 network '192.168.0.0/24' - set protocols ospf area 0 network '10.0.2.0/24' - set protocols ospf parameters router-id '192.168.0.2' - - -DHCP Relay -"""""""""" - -.. code-block:: none - - set interfaces ethernet eth0 address '10.0.1.2/24' - set interfaces ethernet eth1 address '192.168.0.1/24' - set interfaces loopback lo address '10.100.100.1' - set interfaces tunnel tun100 address '172.16.0.1/30' - set interfaces tunnel tun100 encapsulation 'gre-bridge' - set interfaces tunnel tun100 source-address '192.168.0.1' - set interfaces tunnel tun100 remote '10.0.2.1' - set protocols ospf area 0 network '10.0.1.0/24' - set protocols ospf area 0 network '192.168.0.0/24' - set protocols ospf area 0 network '10.100.100.0/24' - set protocols ospf parameters router-id '10.100.100.1' - set protocols static interface-route 192.168.3.3/32 next-hop-interface tun100 - set service dhcp-relay interface 'eth0' - set service dhcp-relay interface 'tun100' - set service dhcp-relay server '192.168.3.3' diff --git a/docs/configexamples/dual-hub-dmvpn.rst b/docs/configexamples/dual-hub-dmvpn.rst new file mode 100644 index 00000000..f2d09391 --- /dev/null +++ b/docs/configexamples/dual-hub-dmvpn.rst @@ -0,0 +1,1258 @@ + +######################## +Dual-Hub DMVPN with VyOS +######################## + +DMVPN is a Dynamic Multipoint VPN technology that provides the capability +for creating a dynamic-mesh VPN network without having to pre-configure +(static) all possible tunnel end-point peers those simplifying deployment +and management of the newly added remote sites. There are 3 main protocols +primarily used to implement DMVPN: + +* NHRP - provides the dynamic tunnel endpoint discovery mechanism (endpoint + registration, and endpoint discovery/lookup) +* mGRE - provides the tunnel encapsulation itself +* IPSec - protocols handle the key exchange, and crypto mechanism + +For this example we are using the following devices: + +* 2 x Hubs +* 3 x Spokes +* 1 x Client device (VPC) +* 1 x ISP router + +The following software was used in the creation of this document: + +* Operating system: VyOS +* Version: 1.3-beta-202112090443 +* Image name: vyos-1.3-beta-202112090443-amd64.iso + + + +******** +Topology +******** +.. image:: /_static/images/VyOS_Dual-Hub_DMVPN.png + :width: 80% + :align: center + :alt: Network Topology Diagram + + + +****************************************** +Network Addressing and Protocol Parameters +****************************************** + +The following ip addressing schema used for the devices IPv4 connectivity: + ++-----------------------------------------------------------------------------+ +|10.X1.0.0/30 - p2p Hubs to ISP networks, where X is Hub site number | ++-----------------------------------------------------------------------------+ +|10.Y1.1.0/24 - p2p Spokes to ISP networks(DHCP), where Y is Spoke site number| ++-----------------------------------------------------------------------------+ +|172.16.253.0/29 - tunnels addressing for Hub-1 connections | ++-----------------------------------------------------------------------------+ +|172.16.254.0/29 - tunnels addressing for Hub-2 connections | ++-----------------------------------------------------------------------------+ +|192.168.0.0/24 - HQ site local network | ++-----------------------------------------------------------------------------+ +|192.168.Z.0/24 - remote sites local network, where Z is Spoke site number | ++-----------------------------------------------------------------------------+ + +eBGP parameters for the routers: + ++----------------------------------------------+ +|AS65000 - HQ (Hub-1 and Hub-2) | ++----------------------------------------------+ +|AS6500X - Spokes, where X is Spoke site number| ++----------------------------------------------+ + + + +************* +Configuration +************* + + + +Step-1: Basic connectivity configuration +======================================== + +- Hub-1: + +.. code-block:: none + + set interfaces ethernet eth0 address '10.11.0.1/30' + set interfaces ethernet eth1 address '192.168.0.1/24' + set protocols static route 0.0.0.0/0 next-hop 10.11.0.2 + set system host-name 'Hub-1' + +- Hub-2: + +.. code-block:: none + + set interfaces ethernet eth0 address '10.21.0.1/30' + set interfaces ethernet eth1 address '192.168.0.2/24' + set protocols static route 0.0.0.0/0 next-hop 10.21.0.2 + set system host-name 'Hub-2' + +- Spoke-1: + +.. code-block:: none + + set interfaces ethernet eth0 address 'dhcp' + set interfaces ethernet eth1 address '192.168.1.1/24' + set system host-name 'Spoke-1' + +- Spoke-2: + +.. code-block:: none + + set interfaces ethernet eth0 address 'dhcp' + set interfaces ethernet eth1 address '192.168.2.1/24' + set system host-name 'Spoke-2' + +- Spoke-3: + +.. code-block:: none + + set interfaces ethernet eth0 address 'dhcp' + set interfaces ethernet eth1 address '192.168.3.1/24' + set system host-name 'Spoke-3' + +- ISP-1: + +.. code-block:: none + + set interfaces ethernet eth0 address '10.11.0.2/30' + set interfaces ethernet eth1 address '10.21.0.2/30' + set interfaces ethernet eth2 address '10.31.1.1/24' + set interfaces ethernet eth3 address '10.21.1.1/24' + set interfaces ethernet eth4 address '10.11.1.1/24' + set service dhcp-server shared-network-name SPK-1 authoritative + set service dhcp-server shared-network-name SPK-1 subnet 10.11.1.0/24 default-router '10.11.1.1' + set service dhcp-server shared-network-name SPK-1 subnet 10.11.1.0/24 range 1 start '10.11.1.10' + set service dhcp-server shared-network-name SPK-1 subnet 10.11.1.0/24 range 1 stop '10.11.1.100' + set service dhcp-server shared-network-name SPK-2 authoritative + set service dhcp-server shared-network-name SPK-2 subnet 10.21.1.0/24 default-router '10.21.1.1' + set service dhcp-server shared-network-name SPK-2 subnet 10.21.1.0/24 range 1 start '10.21.1.10' + set service dhcp-server shared-network-name SPK-2 subnet 10.21.1.0/24 range 1 stop '10.21.1.100' + set service dhcp-server shared-network-name SPK-3 authoritative + set service dhcp-server shared-network-name SPK-3 subnet 10.31.1.0/24 default-router '10.31.1.1' + set service dhcp-server shared-network-name SPK-3 subnet 10.31.1.0/24 range 1 start '10.31.1.10' + set service dhcp-server shared-network-name SPK-3 subnet 10.31.1.0/24 range 1 stop '10.31.1.100' + set system host-name 'ISP1' + + + +Step-2: VRRP configuration for HQ Local network redundancy +========================================================== + +Here we are using VRRP as a local redundancy protocol between Hub-1 and Hub-2. +Initially, Hub-1 operates as an Active and Hub-2 as a Standby router. +Additionally, health-check and script are used to track uplinks and properly +switch mastership between Hub nodes based on the upstream router +reachability (ISP-1). **Note, that before adding local paths to the scripts into +configuration, you have to create and make them executable first**. + +Hub-1 and Hub-2 VRRP health-check script: +_________________________________________ + +* /config/scripts/vrrp-check.sh + +.. code-block:: none + + #!/bin/bash + + eth0status="$(cat /sys/class/net/eth0/operstate | grep 'up')" + + if [[ ! -z ${eth0status} ]]; then + eth0gw="$(ip -j r show 0.0.0.0/0 dev eth0 | awk 'match($0, /\"gateway":\"([[:digit:]\.]+)/, gw) {print gw[1]}')" + if [[ ! -z $eth0gw ]]; then + /bin/ping -I eth0 -c 1 -W 1 $eth0gw && exit 0 || exit 1 + else + exit 1 + fi + else + #Exit 0 because eth0 down is handled by vrrp transition + exit 0 + fi + + +**Note**: some parts of the script might be dependent on your network topology +and connectivity. Be careful before using it on your own devices. + + +Hub-1 and Hub-2 VRRP configuration: +___________________________________ + +* Hub-1 + +.. code-block:: none + + set high-availability vrrp group HQ health-check failure-count '3' + set high-availability vrrp group HQ health-check interval '1' + set high-availability vrrp group HQ health-check script '/config/scripts/vrrp-check.sh' + set high-availability vrrp group HQ interface 'eth1' + set high-availability vrrp group HQ no-preempt + set high-availability vrrp group HQ priority '200' + set high-availability vrrp group HQ rfc3768-compatibility + set high-availability vrrp group HQ virtual-address '192.168.0.254/24' + set high-availability vrrp group HQ vrid '1' + +* Hub-2: + +.. code-block:: none + + set high-availability vrrp group HQ health-check failure-count '3' + set high-availability vrrp group HQ health-check interval '1' + set high-availability vrrp group HQ health-check script '/config/scripts/vrrp-check.sh' + set high-availability vrrp group HQ interface 'eth1' + set high-availability vrrp group HQ no-preempt + set high-availability vrrp group HQ priority '100' + set high-availability vrrp group HQ rfc3768-compatibility + set high-availability vrrp group HQ virtual-address '192.168.0.254/24' + set high-availability vrrp group HQ vrid '1' + + + +Step-3: DMVPN configuration between Hub and Spoke devices +========================================================= + +This section provides an example configuration of the DMVPN enabled devices. +Hub devices are configured with static IPv4 addresses on the uplink interfaces +while Spoke devices receive addresses dynamically from a pre-defined DHCP +pool configured on ISP router. For redundancy purposes, we use 1 tunnel +interface on each Hub device and 2 tunnel interfaces on Spoke devices +destined to each of the Hubs. For the optimal tunnel operation timers are +significantly decreased and set to the following values: + +**NHRP** tunnel holding time - 30 seconds + +**IKE DPD** enabled with "restart" action set, interval 3 and timeout +30 seconds + +**Note**: these values are used only for the lab demonstration and may not +suit exclusive production networks. + +- Hub-1: + +.. code-block:: none + + set interfaces tunnel tun100 address '172.16.253.134/29' + set interfaces tunnel tun100 encapsulation 'gre' + set interfaces tunnel tun100 multicast 'enable' + set interfaces tunnel tun100 parameters ip key '1' + set interfaces tunnel tun100 source-address '10.11.0.1' + + set protocols nhrp tunnel tun100 cisco-authentication 'secret' + set protocols nhrp tunnel tun100 holding-time '30' + set protocols nhrp tunnel tun100 multicast 'dynamic' + set protocols nhrp tunnel tun100 redirect + set protocols nhrp tunnel tun100 shortcut + + set vpn ipsec esp-group ESP-HUB compression 'disable' + set vpn ipsec esp-group ESP-HUB lifetime '1800' + set vpn ipsec esp-group ESP-HUB mode 'transport' + set vpn ipsec esp-group ESP-HUB pfs 'dh-group2' + set vpn ipsec esp-group ESP-HUB proposal 1 encryption 'aes256' + set vpn ipsec esp-group ESP-HUB proposal 1 hash 'sha1' + set vpn ipsec esp-group ESP-HUB proposal 2 encryption '3des' + set vpn ipsec esp-group ESP-HUB proposal 2 hash 'md5' + set vpn ipsec ike-group IKE-HUB close-action 'none' + set vpn ipsec ike-group IKE-HUB dead-peer-detection action 'restart' + set vpn ipsec ike-group IKE-HUB dead-peer-detection interval '3' + set vpn ipsec ike-group IKE-HUB dead-peer-detection timeout '30' + set vpn ipsec ike-group IKE-HUB ikev2-reauth 'no' + set vpn ipsec ike-group IKE-HUB key-exchange 'ikev2' + set vpn ipsec ike-group IKE-HUB lifetime '3600' + set vpn ipsec ike-group IKE-HUB proposal 1 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 1 encryption 'aes256' + set vpn ipsec ike-group IKE-HUB proposal 1 hash 'sha1' + set vpn ipsec ike-group IKE-HUB proposal 2 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 2 encryption 'aes128' + set vpn ipsec ike-group IKE-HUB proposal 2 hash 'sha1' + set vpn ipsec ipsec-interfaces interface 'eth0' + set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret 'secret' + set vpn ipsec profile NHRPVPN bind tunnel 'tun100' + set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' + set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' + +- Hub-2: + +.. code-block:: none + + set interfaces tunnel tun100 address '172.16.254.134/29' + set interfaces tunnel tun100 encapsulation 'gre' + set interfaces tunnel tun100 multicast 'enable' + set interfaces tunnel tun100 parameters ip key '2' + set interfaces tunnel tun100 source-address '10.21.0.1' + + set protocols nhrp tunnel tun100 cisco-authentication 'secret' + set protocols nhrp tunnel tun100 holding-time '30' + set protocols nhrp tunnel tun100 multicast 'dynamic' + set protocols nhrp tunnel tun100 redirect + set protocols nhrp tunnel tun100 shortcut + + set vpn ipsec esp-group ESP-HUB compression 'disable' + set vpn ipsec esp-group ESP-HUB lifetime '1800' + set vpn ipsec esp-group ESP-HUB mode 'transport' + set vpn ipsec esp-group ESP-HUB pfs 'dh-group2' + set vpn ipsec esp-group ESP-HUB proposal 1 encryption 'aes256' + set vpn ipsec esp-group ESP-HUB proposal 1 hash 'sha1' + set vpn ipsec esp-group ESP-HUB proposal 2 encryption '3des' + set vpn ipsec esp-group ESP-HUB proposal 2 hash 'md5' + set vpn ipsec ike-group IKE-HUB close-action 'none' + set vpn ipsec ike-group IKE-HUB dead-peer-detection action 'restart' + set vpn ipsec ike-group IKE-HUB dead-peer-detection interval '3' + set vpn ipsec ike-group IKE-HUB dead-peer-detection timeout '30' + set vpn ipsec ike-group IKE-HUB ikev2-reauth 'no' + set vpn ipsec ike-group IKE-HUB key-exchange 'ikev2' + set vpn ipsec ike-group IKE-HUB lifetime '3600' + set vpn ipsec ike-group IKE-HUB proposal 1 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 1 encryption 'aes256' + set vpn ipsec ike-group IKE-HUB proposal 1 hash 'sha1' + set vpn ipsec ike-group IKE-HUB proposal 2 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 2 encryption 'aes128' + set vpn ipsec ike-group IKE-HUB proposal 2 hash 'sha1' + set vpn ipsec ipsec-interfaces interface 'eth0' + set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret 'secret' + set vpn ipsec profile NHRPVPN bind tunnel 'tun100' + set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' + set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' + +- Spoke-1: + +.. code-block:: none + + set interfaces tunnel tun100 address '172.16.253.131/29' + set interfaces tunnel tun100 encapsulation 'gre' + set interfaces tunnel tun100 multicast 'enable' + set interfaces tunnel tun100 parameters ip key '1' + set interfaces tunnel tun100 source-address '0.0.0.0' + set interfaces tunnel tun200 address '172.16.254.131/29' + set interfaces tunnel tun200 encapsulation 'gre' + set interfaces tunnel tun200 multicast 'enable' + set interfaces tunnel tun200 parameters ip key '2' + set interfaces tunnel tun200 source-address '0.0.0.0' + + set protocols nhrp tunnel tun100 cisco-authentication 'secret' + set protocols nhrp tunnel tun100 holding-time '30' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 nbma-address '10.11.0.1' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 register + set protocols nhrp tunnel tun100 multicast 'nhs' + set protocols nhrp tunnel tun100 redirect + set protocols nhrp tunnel tun100 shortcut + set protocols nhrp tunnel tun200 cisco-authentication 'secret' + set protocols nhrp tunnel tun200 holding-time '30' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 nbma-address '10.21.0.1' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 register + set protocols nhrp tunnel tun200 multicast 'nhs' + set protocols nhrp tunnel tun200 redirect + set protocols nhrp tunnel tun200 shortcut + + set vpn ipsec esp-group ESP-HUB compression 'disable' + set vpn ipsec esp-group ESP-HUB lifetime '1800' + set vpn ipsec esp-group ESP-HUB mode 'transport' + set vpn ipsec esp-group ESP-HUB pfs 'dh-group2' + set vpn ipsec esp-group ESP-HUB proposal 1 encryption 'aes256' + set vpn ipsec esp-group ESP-HUB proposal 1 hash 'sha1' + set vpn ipsec esp-group ESP-HUB proposal 2 encryption '3des' + set vpn ipsec esp-group ESP-HUB proposal 2 hash 'md5' + set vpn ipsec ike-group IKE-HUB close-action 'none' + set vpn ipsec ike-group IKE-HUB dead-peer-detection action 'restart' + set vpn ipsec ike-group IKE-HUB dead-peer-detection interval '3' + set vpn ipsec ike-group IKE-HUB dead-peer-detection timeout '30' + set vpn ipsec ike-group IKE-HUB ikev2-reauth 'no' + set vpn ipsec ike-group IKE-HUB key-exchange 'ikev2' + set vpn ipsec ike-group IKE-HUB lifetime '3600' + set vpn ipsec ike-group IKE-HUB proposal 1 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 1 encryption 'aes256' + set vpn ipsec ike-group IKE-HUB proposal 1 hash 'sha1' + set vpn ipsec ike-group IKE-HUB proposal 2 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 2 encryption 'aes128' + set vpn ipsec ike-group IKE-HUB proposal 2 hash 'sha1' + set vpn ipsec ipsec-interfaces interface 'eth0' + set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret 'secret' + set vpn ipsec profile NHRPVPN bind tunnel 'tun100' + set vpn ipsec profile NHRPVPN bind tunnel 'tun200' + set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' + set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' + +- Spoke-2: + +.. code-block:: none + + set interfaces tunnel tun100 address '172.16.253.132/29' + set interfaces tunnel tun100 encapsulation 'gre' + set interfaces tunnel tun100 multicast 'enable' + set interfaces tunnel tun100 parameters ip key '1' + set interfaces tunnel tun100 source-address '0.0.0.0' + set interfaces tunnel tun200 address '172.16.254.132/29' + set interfaces tunnel tun200 encapsulation 'gre' + set interfaces tunnel tun200 multicast 'enable' + set interfaces tunnel tun200 parameters ip key '2' + set interfaces tunnel tun200 source-address '0.0.0.0' + + set protocols nhrp tunnel tun100 cisco-authentication 'secret' + set protocols nhrp tunnel tun100 holding-time '30' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 nbma-address '10.11.0.1' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 register + set protocols nhrp tunnel tun100 multicast 'nhs' + set protocols nhrp tunnel tun100 redirect + set protocols nhrp tunnel tun100 shortcut + set protocols nhrp tunnel tun200 cisco-authentication 'secret' + set protocols nhrp tunnel tun200 holding-time '30' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 nbma-address '10.21.0.1' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 register + set protocols nhrp tunnel tun200 multicast 'nhs' + set protocols nhrp tunnel tun200 redirect + set protocols nhrp tunnel tun200 shortcut + + set vpn ipsec esp-group ESP-HUB compression 'disable' + set vpn ipsec esp-group ESP-HUB lifetime '1800' + set vpn ipsec esp-group ESP-HUB mode 'transport' + set vpn ipsec esp-group ESP-HUB pfs 'dh-group2' + set vpn ipsec esp-group ESP-HUB proposal 1 encryption 'aes256' + set vpn ipsec esp-group ESP-HUB proposal 1 hash 'sha1' + set vpn ipsec esp-group ESP-HUB proposal 2 encryption '3des' + set vpn ipsec esp-group ESP-HUB proposal 2 hash 'md5' + set vpn ipsec ike-group IKE-HUB close-action 'none' + set vpn ipsec ike-group IKE-HUB dead-peer-detection action 'restart' + set vpn ipsec ike-group IKE-HUB dead-peer-detection interval '3' + set vpn ipsec ike-group IKE-HUB dead-peer-detection timeout '30' + set vpn ipsec ike-group IKE-HUB ikev2-reauth 'no' + set vpn ipsec ike-group IKE-HUB key-exchange 'ikev2' + set vpn ipsec ike-group IKE-HUB lifetime '3600' + set vpn ipsec ike-group IKE-HUB proposal 1 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 1 encryption 'aes256' + set vpn ipsec ike-group IKE-HUB proposal 1 hash 'sha1' + set vpn ipsec ike-group IKE-HUB proposal 2 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 2 encryption 'aes128' + set vpn ipsec ike-group IKE-HUB proposal 2 hash 'sha1' + set vpn ipsec ipsec-interfaces interface 'eth0' + set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret 'secret' + set vpn ipsec profile NHRPVPN bind tunnel 'tun100' + set vpn ipsec profile NHRPVPN bind tunnel 'tun200' + set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' + set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' + +- Spoke-3: + +.. code-block:: none + + set interfaces tunnel tun100 address '172.16.253.133/29' + set interfaces tunnel tun100 encapsulation 'gre' + set interfaces tunnel tun100 multicast 'enable' + set interfaces tunnel tun100 parameters ip key '1' + set interfaces tunnel tun100 source-address '0.0.0.0' + set interfaces tunnel tun200 address '172.16.254.133/29' + set interfaces tunnel tun200 encapsulation 'gre' + set interfaces tunnel tun200 multicast 'enable' + set interfaces tunnel tun200 parameters ip key '2' + set interfaces tunnel tun200 source-address '0.0.0.0' + + set protocols nhrp tunnel tun100 cisco-authentication 'secret' + set protocols nhrp tunnel tun100 holding-time '30' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 nbma-address '10.11.0.1' + set protocols nhrp tunnel tun100 map 172.16.253.134/29 register + set protocols nhrp tunnel tun100 multicast 'nhs' + set protocols nhrp tunnel tun100 redirect + set protocols nhrp tunnel tun100 shortcut + set protocols nhrp tunnel tun200 cisco-authentication 'secret' + set protocols nhrp tunnel tun200 holding-time '30' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 nbma-address '10.21.0.1' + set protocols nhrp tunnel tun200 map 172.16.254.134/29 register + set protocols nhrp tunnel tun200 multicast 'nhs' + set protocols nhrp tunnel tun200 redirect + set protocols nhrp tunnel tun200 shortcut + + set vpn ipsec esp-group ESP-HUB compression 'disable' + set vpn ipsec esp-group ESP-HUB lifetime '1800' + set vpn ipsec esp-group ESP-HUB mode 'transport' + set vpn ipsec esp-group ESP-HUB pfs 'dh-group2' + set vpn ipsec esp-group ESP-HUB proposal 1 encryption 'aes256' + set vpn ipsec esp-group ESP-HUB proposal 1 hash 'sha1' + set vpn ipsec esp-group ESP-HUB proposal 2 encryption '3des' + set vpn ipsec esp-group ESP-HUB proposal 2 hash 'md5' + set vpn ipsec ike-group IKE-HUB close-action 'none' + set vpn ipsec ike-group IKE-HUB dead-peer-detection action 'restart' + set vpn ipsec ike-group IKE-HUB dead-peer-detection interval '3' + set vpn ipsec ike-group IKE-HUB dead-peer-detection timeout '30' + set vpn ipsec ike-group IKE-HUB ikev2-reauth 'no' + set vpn ipsec ike-group IKE-HUB key-exchange 'ikev2' + set vpn ipsec ike-group IKE-HUB lifetime '3600' + set vpn ipsec ike-group IKE-HUB proposal 1 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 1 encryption 'aes256' + set vpn ipsec ike-group IKE-HUB proposal 1 hash 'sha1' + set vpn ipsec ike-group IKE-HUB proposal 2 dh-group '2' + set vpn ipsec ike-group IKE-HUB proposal 2 encryption 'aes128' + set vpn ipsec ike-group IKE-HUB proposal 2 hash 'sha1' + set vpn ipsec ipsec-interfaces interface 'eth0' + set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret 'secret' + set vpn ipsec profile NHRPVPN bind tunnel 'tun100' + set vpn ipsec profile NHRPVPN bind tunnel 'tun200' + set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' + set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' + + + +Step-4: Enabling eBGP as a Dynamic Routing Protocol between Hubs and Spokes +=========================================================================== + +For the simplified and better network management we're using eBGP for routing +information exchange between devices. As we're using Active-Standby mode in +this example, Hub-2 is configured with AS-prepand as an export route-policy +and VRRP transition scripts are used for switching mastership based on the +current link/device state. Also, we use multihop BFD for faster eBGP failure +detection. + +Hub-1 and Hub-2 VRRP transition scripts: +________________________________________ + +* /config/scripts/vrrp-master.sh + +.. code-block:: none + + #!/bin/vbash + + if [ $(id -gn) != vyattacfg ]; then + exec sg vyattacfg "$0 $*" + fi + + source /opt/vyatta/etc/functions/script-template + + configure + delete protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map export AS65000-PREP + commit + + exit + + +* /config/scripts/vrrp-fail.sh + +.. code-block:: none + + #!/bin/vbash + + if [ $(id -gn) != vyattacfg ]; then + exec sg vyattacfg "$0 $*" + fi + + source /opt/vyatta/etc/functions/script-template + + configure + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map export AS65000-PREP + commit + + exit + + +**Note**: some parts of the script might be dependent on your network topology +and connectivity. Be careful before using it on your own devices. + + +Hub devices configuration: +__________________________ + +- Hub-1: + +.. code-block:: none + + set high-availability vrrp group HQ transition-script backup '/config/scripts/vrrp-fail.sh' + set high-availability vrrp group HQ transition-script fault '/config/scripts/vrrp-fail.sh' + set high-availability vrrp group HQ transition-script master '/config/scripts/vrrp-master.sh' + set high-availability vrrp group HQ transition-script stop '/config/scripts/vrrp-fail.sh' + + set policy route-map AS65000-PREP rule 1 action 'permit' + set policy route-map AS65000-PREP rule 1 set as-path-prepend '65000 65000 65000' + + set protocols bfd peer 172.16.253.131 interval multiplier '3' + set protocols bfd peer 172.16.253.131 interval receive '300' + set protocols bfd peer 172.16.253.131 interval transmit '300' + set protocols bfd peer 172.16.253.131 multihop + set protocols bfd peer 172.16.253.131 source address '172.16.253.134' + set protocols bfd peer 172.16.253.132 interval multiplier '3' + set protocols bfd peer 172.16.253.132 interval receive '300' + set protocols bfd peer 172.16.253.132 interval transmit '300' + set protocols bfd peer 172.16.253.132 multihop + set protocols bfd peer 172.16.253.132 source address '172.16.253.134' + set protocols bfd peer 172.16.253.133 interval multiplier '3' + set protocols bfd peer 172.16.253.133 interval receive '300' + set protocols bfd peer 172.16.253.133 interval transmit '300' + set protocols bfd peer 172.16.253.133 multihop + set protocols bfd peer 172.16.253.133 source address '172.16.253.134' + + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.253.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.253.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.253.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 parameters network-import-check + set protocols bgp 65000 peer-group DMVPN bfd + +- Hub-2: + +.. code-block:: none + + set high-availability vrrp group HQ transition-script backup '/config/scripts/vrrp-fail.sh' + set high-availability vrrp group HQ transition-script fault '/config/scripts/vrrp-fail.sh' + set high-availability vrrp group HQ transition-script master '/config/scripts/vrrp-master.sh' + set high-availability vrrp group HQ transition-script stop '/config/scripts/vrrp-fail.sh' + + set policy route-map AS65000-PREP rule 1 action 'permit' + set policy route-map AS65000-PREP rule 1 set as-path-prepend '65000 65000 65000' + + set protocols bfd peer 172.16.254.131 interval multiplier '3' + set protocols bfd peer 172.16.254.131 interval receive '300' + set protocols bfd peer 172.16.254.131 interval transmit '300' + set protocols bfd peer 172.16.254.131 multihop + set protocols bfd peer 172.16.254.131 source address '172.16.254.134' + set protocols bfd peer 172.16.254.132 interval multiplier '3' + set protocols bfd peer 172.16.254.132 interval receive '300' + set protocols bfd peer 172.16.254.132 interval transmit '300' + set protocols bfd peer 172.16.254.132 multihop + set protocols bfd peer 172.16.254.132 source address '172.16.254.134' + set protocols bfd peer 172.16.254.133 interval multiplier '3' + set protocols bfd peer 172.16.254.133 interval receive '300' + set protocols bfd peer 172.16.254.133 interval transmit '300' + set protocols bfd peer 172.16.254.133 multihop + set protocols bfd peer 172.16.254.133 source address '172.16.254.134' + + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.254.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.254.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.254.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 parameters network-import-check + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map export 'AS65000-PREP' + set protocols bgp 65000 peer-group DMVPN bfd + +Spoke devices configuration: +____________________________ + +- Spoke-1: + +.. code-block:: none + + set protocols bfd peer 172.16.253.134 interval multiplier '3' + set protocols bfd peer 172.16.253.134 interval receive '300' + set protocols bfd peer 172.16.253.134 interval transmit '300' + set protocols bfd peer 172.16.253.134 multihop + set protocols bfd peer 172.16.253.134 source address '172.16.253.131' + set protocols bfd peer 172.16.254.134 interval multiplier '3' + set protocols bfd peer 172.16.254.134 interval receive '300' + set protocols bfd peer 172.16.254.134 interval transmit '300' + set protocols bfd peer 172.16.254.134 multihop + set protocols bfd peer 172.16.254.134 source address '172.16.254.131' + + set protocols bgp 65001 address-family ipv4-unicast network 192.168.1.0/24 + set protocols bgp 65001 neighbor 172.16.253.134 address-family ipv4-unicast + set protocols bgp 65001 neighbor 172.16.253.134 bfd + set protocols bgp 65001 neighbor 172.16.253.134 remote-as '65000' + set protocols bgp 65001 neighbor 172.16.254.134 address-family ipv4-unicast + set protocols bgp 65001 neighbor 172.16.254.134 bfd + set protocols bgp 65001 neighbor 172.16.254.134 remote-as '65000' + set protocols bgp 65001 parameters log-neighbor-changes + +- Spoke-2: + +.. code-block:: none + + set protocols bfd peer 172.16.253.134 interval multiplier '3' + set protocols bfd peer 172.16.253.134 interval receive '300' + set protocols bfd peer 172.16.253.134 interval transmit '300' + set protocols bfd peer 172.16.253.134 multihop + set protocols bfd peer 172.16.253.134 source address '172.16.253.132' + set protocols bfd peer 172.16.254.134 interval multiplier '3' + set protocols bfd peer 172.16.254.134 interval receive '300' + set protocols bfd peer 172.16.254.134 interval transmit '300' + set protocols bfd peer 172.16.254.134 multihop + set protocols bfd peer 172.16.254.134 source address '172.16.254.132' + + set protocols bgp 65002 address-family ipv4-unicast network 192.168.2.0/24 + set protocols bgp 65002 neighbor 172.16.253.134 address-family ipv4-unicast + set protocols bgp 65002 neighbor 172.16.253.134 bfd + set protocols bgp 65002 neighbor 172.16.253.134 remote-as '65000' + set protocols bgp 65002 neighbor 172.16.254.134 address-family ipv4-unicast + set protocols bgp 65002 neighbor 172.16.254.134 bfd + set protocols bgp 65002 neighbor 172.16.254.134 remote-as '65000' + set protocols bgp 65002 parameters log-neighbor-changes + +- Spoke-3: + +.. code-block:: none + + set protocols bfd peer 172.16.253.134 interval multiplier '3' + set protocols bfd peer 172.16.253.134 interval receive '300' + set protocols bfd peer 172.16.253.134 interval transmit '300' + set protocols bfd peer 172.16.253.134 multihop + set protocols bfd peer 172.16.253.134 source address '172.16.253.133' + set protocols bfd peer 172.16.254.134 interval multiplier '3' + set protocols bfd peer 172.16.254.134 interval receive '300' + set protocols bfd peer 172.16.254.134 interval transmit '300' + set protocols bfd peer 172.16.254.134 multihop + set protocols bfd peer 172.16.254.134 source address '172.16.254.133' + + set protocols bgp 65003 address-family ipv4-unicast network 192.168.3.0/24 + set protocols bgp 65003 neighbor 172.16.253.134 address-family ipv4-unicast + set protocols bgp 65003 neighbor 172.16.253.134 bfd + set protocols bgp 65003 neighbor 172.16.253.134 remote-as '65000' + set protocols bgp 65003 neighbor 172.16.254.134 address-family ipv4-unicast + set protocols bgp 65003 neighbor 172.16.254.134 bfd + set protocols bgp 65003 neighbor 172.16.254.134 remote-as '65000' + set protocols bgp 65003 parameters log-neighbor-changes + +**Note**: In case if you're using VyOS version that has a VRRP transition +scripts issues after a device reboot, as a temporary solution you may add +postconfig-bootup script that reloads **keepalived** process additionally after +the device booted. + +- Hub devices /config/scripts/vyos-postconfig-bootup.script: + +.. code-block:: none + + #!/bin/sh + # This script is executed at boot time after VyOS configuration is fully applied. + # Any modifications required to work around unfixed bugs + # or use services not available through the VyOS CLI system can be placed here. + + echo "Reloading VRRP process" + sudo systemctl restart keepalived.service + echo "VRRP process reload completed" + + + +Step-5: Verification +==================== + +Now, it's time to check that all protocols are working as expected and mastership +during the failover switches correctly between Hub devices. + +- Checking VRRP state between Hub-1 and Hub-2: + +.. code-block:: none + + vyos@Hub-1:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 MASTER 200 14s + + vyos@Hub-2:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 BACKUP 100 29s + +- Checking NHRP and eBGP sessions between Hub and Spoke devices: + +.. code-block:: none + + vyos@Hub-1:~$ show nhrp tunnel + Status: ok + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.135/32 + Alias-Address: 172.16.253.134 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.134/32 + Flags: up + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.253.131/32 + NBMA-Address: 10.11.1.11 + Flags: up + Expires-In: 0:23 + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.253.133/32 + NBMA-Address: 10.31.1.11 + Flags: up + Expires-In: 0:22 + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.253.132/32 + NBMA-Address: 10.21.1.11 + Flags: up + Expires-In: 0:21 + + vyos@Hub-1:~$ show bgp summary + + IPv4 Unicast Summary: + BGP router identifier 192.168.0.1, local AS number 65000 vrf-id 0 + BGP table version 20 + RIB entries 7, using 1344 bytes of memory + Peers 3, using 64 KiB of memory + Peer groups 1, using 64 bytes of memory + + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 172.16.253.131 4 65001 26519 26526 0 0 0 00:43:38 1 4 + 172.16.253.132 4 65002 26545 26540 0 0 0 00:46:36 1 4 + 172.16.253.133 4 65003 26528 26520 0 0 0 00:41:59 1 4 + + Total number of neighbors 3 + + + vyos@Hub-2:~$ show nhrp tunnel + Status: ok + + Interface: tun100 + Type: local + Protocol-Address: 172.16.254.135/32 + Alias-Address: 172.16.254.134 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.254.134/32 + Flags: up + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.254.132/32 + NBMA-Address: 10.21.1.11 + Flags: up + Expires-In: 0:28 + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.254.131/32 + NBMA-Address: 10.11.1.11 + Flags: up + Expires-In: 0:21 + + Interface: tun100 + Type: dynamic + Protocol-Address: 172.16.254.133/32 + NBMA-Address: 10.31.1.11 + Flags: up + Expires-In: 0:20 + + vyos@Hub-2:~$ show bgp summary + + IPv4 Unicast Summary: + BGP router identifier 192.168.0.2, local AS number 65000 vrf-id 0 + BGP table version 14 + RIB entries 7, using 1344 bytes of memory + Peers 3, using 64 KiB of memory + Peer groups 1, using 64 bytes of memory + + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 172.16.254.131 4 65001 26516 26516 0 0 0 00:43:03 1 4 + 172.16.254.132 4 65002 26563 26562 0 0 0 00:48:27 1 4 + 172.16.254.133 4 65003 26518 26516 0 0 0 00:42:20 1 4 + + Total number of neighbors 3 + +- Checking BFD sessions between Hub and Spoke devices: + +.. code-block:: none + + vyos@Hub-1:~$ show protocols bfd peers + Session count: 6 + SessionId LocalAddress PeerAddress Status + ========= ============ =========== ====== + 3600626867 172.16.253.134 172.16.253.133 up + 1123939978 172.16.253.134 172.16.253.131 up + 374394280 172.16.253.134 172.16.253.132 up + 1786735466 172.16.253.134 172.16.253.132 up + 1440522544 172.16.253.134 172.16.253.131 up + 1106910911 172.16.253.134 172.16.253.133 up + + + vyos@Hub-2:~$ show protocols bfd peers + Session count: 6 + SessionId LocalAddress PeerAddress Status + ========= ============ =========== ====== + 2442966178 172.16.254.134 172.16.254.133 up + 393258775 172.16.254.134 172.16.254.131 up + 2990308682 172.16.254.134 172.16.254.133 up + 2267910949 172.16.254.134 172.16.254.132 up + 3542474595 172.16.254.134 172.16.254.131 up + 4239538185 172.16.254.134 172.16.254.132 up + +- Checking routing information and connectivity between Hub and Spoke devices: + +.. code-block:: none + + vyos@Hub-1:~$ show ip bgp + BGP table version is 20, local router ID is 192.168.0.1, vrf id 0 + Default local pref 100, local AS 65000 + Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, + i internal, r RIB-failure, S Stale, R Removed + Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self + Origin codes: i - IGP, e - EGP, ? - incomplete + + Network Next Hop Metric LocPrf Weight Path + *> 192.168.0.0/24 0.0.0.0 0 32768 i + *> 192.168.1.0/24 172.16.253.131 0 0 65001 i + *> 192.168.2.0/24 172.16.253.132 0 0 65002 i + *> 192.168.3.0/24 172.16.253.133 0 0 65003 i + + Displayed 4 routes and 4 total paths + + + vyos@Hub-2:~$ show ip bgp + BGP table version is 14, local router ID is 192.168.0.2, vrf id 0 + Default local pref 100, local AS 65000 + Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, + i internal, r RIB-failure, S Stale, R Removed + Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self + Origin codes: i - IGP, e - EGP, ? - incomplete + + Network Next Hop Metric LocPrf Weight Path + *> 192.168.0.0/24 0.0.0.0 0 32768 i + *> 192.168.1.0/24 172.16.254.131 0 0 65001 i + *> 192.168.2.0/24 172.16.254.132 0 0 65002 i + *> 192.168.3.0/24 172.16.254.133 0 0 65003 i + + Displayed 4 routes and 4 total paths + + + vyos@Spoke-1:~$ show ip bgp + BGP table version is 19, local router ID is 192.168.1.1, vrf id 0 + Default local pref 100, local AS 65001 + Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, + i internal, r RIB-failure, S Stale, R Removed + Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self + Origin codes: i - IGP, e - EGP, ? - incomplete + + Network Next Hop Metric LocPrf Weight Path + * 192.168.0.0/24 172.16.254.134 0 0 65000 65000 65000 65000 i + *> 172.16.253.134 0 0 65000 i + *> 192.168.1.0/24 0.0.0.0 0 32768 i + * 192.168.2.0/24 172.16.254.132 0 65000 65000 65000 65000 65002 i + *> 172.16.253.132 0 65000 65002 i + * 192.168.3.0/24 172.16.254.133 0 65000 65000 65000 65000 65003 i + *> 172.16.253.133 0 65000 65003 i + + Displayed 4 routes and 7 total paths + +As you can see, Hub-2 announces routes with longer(prepended) AS path as +we've configured it previously, those, traffic towards HQ subnet will be +forwarded over Hub-1 which is operating as an Active VRRP router. Let's +check connectivity and the path from Spoke-1 to the HQ local network: + +.. code-block:: none + + vyos@Spoke-1:~$ ping 192.168.0.10 count 5 interface 192.168.1.1 + PING 192.168.0.10 (192.168.0.10) from 192.168.1.1 : 56(84) bytes of data. + 64 bytes from 192.168.0.10: icmp_seq=1 ttl=63 time=3.50 ms + 64 bytes from 192.168.0.10: icmp_seq=2 ttl=63 time=2.45 ms + 64 bytes from 192.168.0.10: icmp_seq=3 ttl=63 time=2.34 ms + 64 bytes from 192.168.0.10: icmp_seq=4 ttl=63 time=2.20 ms + 64 bytes from 192.168.0.10: icmp_seq=5 ttl=63 time=2.44 ms + + --- 192.168.0.10 ping statistics --- + 5 packets transmitted, 5 received, 0% packet loss, time 11ms + rtt min/avg/max/mdev = 2.195/2.583/3.496/0.465 ms + + vyos@Spoke-1:~$ traceroute 192.168.0.10 + traceroute to 192.168.0.10 (192.168.0.10), 30 hops max, 60 byte packets + 1 172.16.253.134 (172.16.253.134) 0.913 ms 0.884 ms 0.819 ms + 2 192.168.0.10 (192.168.0.10) 1.352 ms 1.446 ms 1.391 ms + +From the output, we can confirm successful connectivity between Spoke-1 and HQ +local networks. From the traceroute we see that the traffic pass through the +Hub-1. + +Now, let's check traffic between Spoke sites. Based on our configuration, Spoke +sites are using shortcut for direct reachability between each other. First, let's +check NHRP tunnels before passing the traffic between Spoke-1 and Spoke-2: + +.. code-block:: none + + vyos@Spoke-1:~$ show nhrp tunnel + Status: ok + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.135/32 + Alias-Address: 172.16.254.131 + Flags: up + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.131/32 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.135/32 + Alias-Address: 172.16.253.131 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.131/32 + Flags: up + + Interface: tun200 + Type: static + Protocol-Address: 172.16.254.134/29 + NBMA-Address: 10.21.0.1 + Flags: used up + + Interface: tun100 + Type: static + Protocol-Address: 172.16.253.134/29 + NBMA-Address: 10.11.0.1 + Flags: used up + + vyos@Spoke-2:~$ show nhrp tunnel + Status: ok + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.135/32 + Alias-Address: 172.16.253.132 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.132/32 + Flags: up + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.135/32 + Alias-Address: 172.16.254.132 + Flags: up + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.132/32 + Flags: up + + Interface: tun100 + Type: static + Protocol-Address: 172.16.253.134/29 + NBMA-Address: 10.11.0.1 + Flags: used up + + Interface: tun200 + Type: static + Protocol-Address: 172.16.254.134/29 + NBMA-Address: 10.21.0.1 + + +After passing traffic we could see that there is additional shortcut tunnel +created between Spoke-1 and Spoke-2 for the direct communication: + +.. code-block:: none + + vyos@Spoke-1:~$ ping 192.168.2.1 count 5 interface 192.168.1.1 + PING 192.168.2.1 (192.168.2.1) from 192.168.1.1 : 56(84) bytes of data. + 64 bytes from 192.168.2.1: icmp_seq=1 ttl=64 time=1.03 ms + 64 bytes from 192.168.2.1: icmp_seq=2 ttl=64 time=0.820 ms + 64 bytes from 192.168.2.1: icmp_seq=3 ttl=64 time=1.13 ms + 64 bytes from 192.168.2.1: icmp_seq=4 ttl=63 time=1.41 ms + 64 bytes from 192.168.2.1: icmp_seq=5 ttl=64 time=0.988 ms + + --- 192.168.2.1 ping statistics --- + 5 packets transmitted, 5 received, 0% packet loss, time 10ms + rtt min/avg/max/mdev = 0.820/1.075/1.412/0.197 ms + + vyos@Spoke-1:~$ traceroute 192.168.2.1 + traceroute to 192.168.2.1 (192.168.2.1), 30 hops max, 60 byte packets + 1 192.168.2.1 (192.168.2.1) 1.172 ms 1.109 ms 1.151 ms + + vyos@Spoke-1:~$ show nhrp tunnel + Status: ok + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.135/32 + Alias-Address: 172.16.254.131 + Flags: up + + Interface: tun200 + Type: local + Protocol-Address: 172.16.254.131/32 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.135/32 + Alias-Address: 172.16.253.131 + Flags: up + + Interface: tun100 + Type: local + Protocol-Address: 172.16.253.131/32 + Flags: up + + Interface: tun200 + Type: static + Protocol-Address: 172.16.254.134/29 + NBMA-Address: 10.21.0.1 + Flags: used up + + ____________________________________ + Interface: tun100 + Type: cached + Protocol-Address: 172.16.253.132/32 + NBMA-Address: 10.21.1.11 + Flags: used up + Expires-In: 0:24 + ____________________________________ + + Interface: tun100 + Type: static + Protocol-Address: 172.16.253.134/29 + NBMA-Address: 10.11.0.1 + Flags: used up + +The same applies to the rest of the devices and works with the same logic. +As we've already confirmed successfull connectivity between Hub and Spoke +devices, let's check failover process. + +- Failover on the health-check failure on Hub-1: + +.. code-block:: none + + # disabling interface towards Hub-1 on ISP router + vyos@ISP1:~$ configure + [edit] + vyos@ISP1# set interfaces ethernet eth0 disable + [edit] + vyos@ISP1# commit + [edit] + vyos@ISP1# + + + # checking VRRP state and eBGP configuration on Hub-1: + vyos@Hub-1:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 FAULT 200 1m15s + + vyos@Hub-1:~$ show configuration commands | match bgp + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.253.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.253.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.253.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map export 'AS65000-PREP' + set protocols bgp 65000 peer-group DMVPN bfd + + + # consecutive pings check from Spoke-1 to the HQ local network during the failure + --- 192.168.0.10 ping statistics --- + 223 packets transmitted, 219 received, 1.79372% packet loss, time 679ms + rtt min/avg/max/mdev = 0.918/2.191/2.957/0.364 ms + vyos@Spoke-1:~$ + + + # consecutive pings check from Spoke-3 to the Spoke-2 local network during the failure + --- 192.168.2.1 ping statistics --- + 265 packets transmitted, 265 received, 0% packet loss, time 690ms + rtt min/avg/max/mdev = 0.663/1.128/2.272/0.285 ms + vyos@Spoke-3:~$ + +**Note**: After bringing ISP interface towards Hub-1 back to UP state, +VRRP state will remain unchanged due to "no-preempt" option enabled +under the VRRP configuration on the Hub-1 and Hub-2 and will be changed +only during link/device failure on Hub-2. + +- Failover during Hub-2 device failure: + +.. code-block:: none + + # Checking VRRP state and eBGP configuration on Hub-2 before reboot + vyos@Hub-2:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 MASTER 100 20m22s + + vyos@Hub-2:~$ show configuration commands | match bgp + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.254.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.254.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.254.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map + set protocols bgp 65000 peer-group DMVPN bfd + + + # Rebooting Hub-2 + vyos@Hub-2:~$ reboot + Are you sure you want to reboot this system? [y/N] y + + + # Checking VRRP state and eBGP configuration on Hub-1 + vyos@Hub-1:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 MASTER 200 1m57s + + vyos@Hub-1:~$ show configuration commands | match bgp + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.253.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.253.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.253.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.253.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map + set protocols bgp 65000 peer-group DMVPN bfd + + + # Checking VRRP state and eBGP configuration on Hub-2 after reboot completed + vyos@Hub-2:~$ show vrrp + Name Interface VRID State Priority Last Transition + ------ ----------- ------ ------- ---------- ----------------- + HQ eth1v1 1 BACKUP 100 1m46s + + vyos@Hub-2:~$ show configuration commands | match bgp + set protocols bgp 65000 address-family ipv4-unicast network 192.168.0.0/24 + set protocols bgp 65000 neighbor 172.16.254.131 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.131 remote-as '65001' + set protocols bgp 65000 neighbor 172.16.254.132 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.132 remote-as '65002' + set protocols bgp 65000 neighbor 172.16.254.133 peer-group 'DMVPN' + set protocols bgp 65000 neighbor 172.16.254.133 remote-as '65003' + set protocols bgp 65000 parameters log-neighbor-changes + set protocols bgp 65000 peer-group DMVPN address-family ipv4-unicast route-map export 'AS65000-PREP' + set protocols bgp 65000 peer-group DMVPN bfd + + + # consecutive pings check from Spoke-1 to the HQ local network during the failure + --- 192.168.0.10 ping statistics --- + 1182 packets transmitted, 1182 received, 0% packet loss, time 1921ms + rtt min/avg/max/mdev = 0.890/1.692/3.305/0.503 ms + vyos@Spoke-1:~$ + + + # consecutive pings check from Spoke-3 to the Spoke-2 local network during the failure + --- 192.168.2.1 ping statistics --- + 1186 packets transmitted, 1186 received, 0% packet loss, time 2100ms + rtt min/avg/max/mdev = 0.506/1.236/8.497/0.369 ms + vyos@Spoke-3:~$ + +From the results, we can see that the switchover performed as expected with +0 packets loss both from Spoke-1 to HQ and Spoke-3 to Spoke-2 networks. diff --git a/docs/configexamples/index.rst b/docs/configexamples/index.rst index d1a822c2..e8dd0918 100644 --- a/docs/configexamples/index.rst +++ b/docs/configexamples/index.rst @@ -8,15 +8,14 @@ This chapter contains various configuration examples: .. toctree:: :maxdepth: 2 - dhcp-relay-through-gre-bridge zone-policy bgp-ipv6-unnumbered ospf-unnumbered azure-vpn-bgp azure-vpn-dual-bgp - tunnelbroker-ipv6 ha wan-load-balancing + dual-hub-dmvpn Configuration Blueprints (autotest) =================================== @@ -42,4 +41,6 @@ The process will do the following steps: .. toctree:: :maxdepth: 1 - autotest/Wireguard/Wireguard
\ No newline at end of file + autotest/tunnelbroker/tunnelbroker + autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE + autotest/Wireguard/Wireguard diff --git a/docs/configuration/firewall/index.rst b/docs/configuration/firewall/index.rst index 954f20cf..92f2da8d 100644 --- a/docs/configuration/firewall/index.rst +++ b/docs/configuration/firewall/index.rst @@ -242,7 +242,7 @@ Rule-Sets A rule-set is a named collection of firewall rules that can be applied to an interface or a zone. Each rule is numbered, has an action to apply if the rule is matched, and the ability to specify the criteria to -match. Data packets go through the rules from 1 - 9999, at the first match +match. Data packets go through the rules from 1 - 999999, at the first match the action of the rule will be executed. .. cfgcmd:: set firewall name <name> description <text> @@ -262,25 +262,26 @@ the action of the rule will be executed. Use this command to enable the logging of the default action. -.. cfgcmd:: set firewall name <name> rule <1-9999> action [drop | reject | - accept] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> action [drop | reject | +.. cfgcmd:: set firewall name <name> rule <1-999999> action [drop | reject | accept] +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> action [drop | + reject | accept] This required setting defines the action of the current rule. -.. cfgcmd:: set firewall name <name> rule <1-9999> description <text> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> description <text> +.. cfgcmd:: set firewall name <name> rule <1-999999> description <text> +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> description <text> Provide a description for each rule. -.. cfgcmd:: set firewall name <name> rule <1-9999> log [disable | enable] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> log [disable | enable] +.. cfgcmd:: set firewall name <name> rule <1-999999> log [disable | enable] +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log [disable | + enable] Enable or disable logging for the matched packet. -.. cfgcmd:: set firewall name <name> rule <1-9999> disable -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> disable +.. cfgcmd:: set firewall name <name> rule <1-999999> disable +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> disable If you want to disable a rule but let it in the configuration. @@ -290,13 +291,13 @@ Matching criteria There are a lot of matching criteria against which the package can be tested. -.. cfgcmd:: set firewall name <name> rule <1-9999> source address +.. cfgcmd:: set firewall name <name> rule <1-999999> source address [address | addressrange | CIDR] -.. cfgcmd:: set firewall name <name> rule <1-9999> destination address +.. cfgcmd:: set firewall name <name> rule <1-999999> destination address [address | addressrange | CIDR] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source address +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source address [address | addressrange | CIDR] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> destination address +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> destination address [address | addressrange | CIDR] This is similar to the network groups part, but here you are able to negate @@ -310,9 +311,9 @@ There are a lot of matching criteria against which the package can be tested. set firewall ipv6-name WAN-IN-v6 rule 100 source address 2001:db8::202 -.. cfgcmd:: set firewall name <name> rule <1-9999> source mac-address +.. cfgcmd:: set firewall name <name> rule <1-999999> source mac-address <mac-address> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source mac-address +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source mac-address <mac-address> Only in the source criteria, you can specify a mac-address. @@ -322,13 +323,13 @@ There are a lot of matching criteria against which the package can be tested. set firewall name LAN-IN-v4 rule 100 source mac-address 00:53:00:11:22:33 set firewall name LAN-IN-v4 rule 101 source mac-address !00:53:00:aa:12:34 -.. cfgcmd:: set firewall name <name> rule <1-9999> source port +.. cfgcmd:: set firewall name <name> rule <1-999999> source port [1-65535 | portname | start-end] -.. cfgcmd:: set firewall name <name> rule <1-9999> destination port +.. cfgcmd:: set firewall name <name> rule <1-999999> destination port [1-65535 | portname | start-end] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source port +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source port [1-65535 | portname | start-end] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> destination port +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> destination port [1-65535 | portname | start-end] A port can be set with a port number or a name which is here @@ -347,42 +348,42 @@ There are a lot of matching criteria against which the package can be tested. set firewall ipv6-name WAN-IN-v6 rule 10 source port '!22,https,3333-3338' -.. cfgcmd:: set firewall name <name> rule <1-9999> source group +.. cfgcmd:: set firewall name <name> rule <1-999999> source group address-group <name> -.. cfgcmd:: set firewall name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall name <name> rule <1-999999> destination group address-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source group address-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> destination group address-group <name> Use a specific address-group -.. cfgcmd:: set firewall name <name> rule <1-9999> source group +.. cfgcmd:: set firewall name <name> rule <1-999999> source group network-group <name> -.. cfgcmd:: set firewall name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall name <name> rule <1-999999> destination group network-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source group network-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> destination group network-group <name> Use a specific network-group -.. cfgcmd:: set firewall name <name> rule <1-9999> source group +.. cfgcmd:: set firewall name <name> rule <1-999999> source group port-group <name> -.. cfgcmd:: set firewall name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall name <name> rule <1-999999> destination group port-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> source group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> source group port-group <name> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> destination group +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> destination group port-group <name> Use a specific port-group -.. cfgcmd:: set firewall name <name> rule <1-9999> protocol [<text> | +.. cfgcmd:: set firewall name <name> rule <1-999999> protocol [<text> | <0-255> | all | tcp_udp] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> protocol [<text> | +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> protocol [<text> | <0-255> | all | tcp_udp] Match a protocol criteria. A protocol number or a name which is here @@ -396,8 +397,8 @@ There are a lot of matching criteria against which the package can be tested. set firewall name WAN-IN-v4 rule 11 protocol !tcp_udp set firewall ipv6-name WAN-IN-v6 rule 10 protocol tcp -.. cfgcmd:: set firewall name <name> rule <1-9999> tcp flags <text> -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> tcp flags <text> +.. cfgcmd:: set firewall name <name> rule <1-999999> tcp flags <text> +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> tcp flags <text> Allowed values fpr TCP flags: ``SYN``, ``ACK``, ``FIN``, ``RST``, ``URG``, ``PSH``, ``ALL`` When specifying more than one flag, flags should be comma @@ -409,9 +410,9 @@ There are a lot of matching criteria against which the package can be tested. set firewall name WAN-IN-v4 rule 12 tcp flags 'SYN' set firewall name WAN-IN-v4 rule 13 tcp flags 'SYN,!ACK,!FIN,!RST' -.. cfgcmd:: set firewall name <name> rule <1-9999> state [established | +.. cfgcmd:: set firewall name <name> rule <1-999999> state [established | invalid | new | related] [enable | disable] -.. cfgcmd:: set firewall ipv6-name <name> rule <1-9999> state [established | +.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> state [established | invalid | new | related] [enable | disable] Match against the state of a packet. @@ -628,7 +629,7 @@ Rule-set overview This will show you a statistic of all rule-sets since the last boot. -.. opcmd:: show firewall [name | ipv6name] <name> rule <1-9999> +.. opcmd:: show firewall [name | ipv6name] <name> rule <1-999999> This command will give an overview of a rule in a single rule-set @@ -664,7 +665,7 @@ Rule-set overview This will show you a rule-set statistic since the last boot. -.. opcmd:: show firewall [name | ipv6name] <name> rule <1-9999> +.. opcmd:: show firewall [name | ipv6name] <name> rule <1-999999> This command will give an overview of a rule in a single rule-set. diff --git a/docs/configuration/protocols/index.rst b/docs/configuration/protocols/index.rst index c302d6a9..8568370d 100644 --- a/docs/configuration/protocols/index.rst +++ b/docs/configuration/protocols/index.rst @@ -1,3 +1,5 @@ +.. _protocols: + ######### Protocols ######### diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 05a851f1..416a42c3 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -1,6 +1,6 @@ .. include:: /_include/need_improvement.txt -.. _isis: +.. _routing-isis: ##### IS-IS @@ -16,51 +16,51 @@ neighbors. IS-IS runs directly on the data link layer (Layer 2). IS-IS addresses are called :abbr:`NETs (Network Entity Titles)` and can be 8 to 20 bytes long, but are generally 10 bytes long. -For example :abbr:`NET (Network Entity Title)` +******* +General +******* -.. code-block:: none +Configuration +============= + +Mandatory Settings +------------------ - 49.0001.1921.6800.1002.00 +.. cfgcmd:: set protocols isis net <network-entity-title> -The IS-IS address consists of three parts: + This commad also sets network entity title (NET) provided in ISO format. - :abbr:`AFI (Address family authority identifier)` - ``49`` The AFI value 49 is what IS-IS uses for private addressing. + For example :abbr:`NET (Network Entity Title)` - Area identifier: - ``0001`` IS-IS area number (Area1) + .. code-block:: none - System identifier: - ``1921.6800.1002`` For system idetifier we recommend to use IP address or - MAC address of the router. + 49.0001.1921.6800.1002.00 - NET selector: - ``00`` Must always be 00, to indicate "this system". + The IS-IS address consists of the following parts: + * :abbr:`AFI (Address family authority identifier)` - ``49`` The AFI value + 49 is what IS-IS uses for private addressing. -General Configuration ---------------------- + * Area identifier: ``0001`` IS-IS area number (Area1) -.. cfgcmd:: set protocols isis <name> net <network-entity-title> + * System identifier: ``1921.6800.1002`` - for system idetifiers we recommend + to use IP address or MAC address of the router itself. - This command enables the ISIS process by specifying the ISIS domain with - ‘name’. ISIS implementation does not yet support multiple ISIS processes - but you must specify the name of ISIS process. This commad also sets - network entity title (NET) provided in ISO format. + * NET selector: ``00`` Must always be 00, to indicate "this system". -.. cfgcmd:: set protocols isis <name> interface <interface> +.. cfgcmd:: set protocols isis interface <interface> This command activates ISIS adjacency on this interface. Note that the name of ISIS instance must be the same as the one used to configure the ISIS process. - -.. cfgcmd:: set protocols isis <name> dynamic-hostname + +.. cfgcmd:: set protocols isis dynamic-hostname This command enables support for dynamic hostname. Dynamic hostname mapping determined as described in :rfc:`2763`, Dynamic Hostname Exchange Mechanism for IS-IS. -.. cfgcmd:: set protocols isis <name> level <level-1|level-1-2|level-2> +.. cfgcmd:: set protocols isis level <level-1|level-1-2|level-2> This command defines the ISIS router behavior: @@ -68,12 +68,12 @@ General Configuration **level-1-2** Act as both a station router and an area router. **level-2-only** Act as an area router only. -.. cfgcmd:: set protocols isis <name> lsp-mtu <size> +.. cfgcmd:: set protocols isis lsp-mtu <size> This command configures the maximum size of generated LSPs, in bytes. The size range is 128 to 4352. -.. cfgcmd:: set protocols isis <name> metric-style <narrow|transition|wide> +.. cfgcmd:: set protocols isis metric-style <narrow|transition|wide> This command sets old-style (ISO 10589) or new-style packet formats: @@ -81,19 +81,19 @@ General Configuration **transition** Send and accept both styles of TLVs during transition. **wide** Use new style of TLVs to carry wider metric. -.. cfgcmd:: set protocols isis <name> purge-originator +.. cfgcmd:: set protocols isis purge-originator This command enables :rfc:`6232` purge originator identification. Enable purge originator identification (POI) by adding the type, length and value (TLV) with the Intermediate System (IS) identification to the LSPs that do not contain POI information. If an IS generates a purge, VyOS adds this TLV - with the system ID of the IS to the purge. + with the system ID of the IS to the purge. -.. cfgcmd:: set protocols isis <name> set-attached-bit +.. cfgcmd:: set protocols isis set-attached-bit This command sets ATT bit to 1 in Level1 LSPs. It is described in :rfc:`3787`. -.. cfgcmd:: set protocols isis <name> set-overload-bit +.. cfgcmd:: set protocols isis set-overload-bit This command sets overload bit to avoid any transit traffic through this router. It is described in :rfc:`3787`. @@ -102,107 +102,108 @@ General Configuration level-1 This command will generate a default-route in L1 database. - + .. cfgcmd:: set protocols isis name default-information originate <ipv4|ipv6> level-2 This command will generate a default-route in L2 database. -Interfaces Configuration ------------------------- +Interface Configuration +----------------------- -.. cfgcmd:: set protocols isis <name> interface <interface> circuit-type +.. cfgcmd:: set protocols isis interface <interface> circuit-type <level-1|level-1-2|level-2-only> This command specifies circuit type for interface: - **level-1** Level-1 only adjacencies are formed. - **level-1-2** Level-1-2 adjacencies are formed - **level-2-only** Level-2 only adjacencies are formed + * **level-1** Level-1 only adjacencies are formed. + * **level-1-2** Level-1-2 adjacencies are formed + * **level-2-only** Level-2 only adjacencies are formed -.. cfgcmd:: set protocols isis <name> interface <interface> hello-interval +.. cfgcmd:: set protocols isis interface <interface> hello-interval <seconds> This command sets hello interval in seconds on a given interface. The range is 1 to 600. -.. cfgcmd:: set protocols isis <name> interface <interface> hello-multiplier +.. cfgcmd:: set protocols isis interface <interface> hello-multiplier <seconds> - This command sets multiplier for hello holding time on a given + This command sets multiplier for hello holding time on a given interface. The range is 2 to 100. -.. cfgcmd:: set protocols isis <name> interface <interface> hello-padding +.. cfgcmd:: set protocols isis interface <interface> hello-padding This command configures padding on hello packets to accommodate asymmetrical maximum transfer units (MTUs) from different hosts as described in :rfc:`3719`. This helps to prevent a premature adjacency Up state when one - routing device’s MTU does not meet the requirements to establish the - adjacency. + routing devices MTU does not meet the requirements to establish the adjacency. + +.. cfgcmd:: set protocols isis interface <interface> metric <metric> -.. cfgcmd:: set protocols isis <name> interface <interface> metric <metric> + This command set default metric for circuit. - This command set default metric for circuit. The metric range is 1 to - 16777215 (Max value depend if metric support narrow or wide value). + The metric range is 1 to 16777215 (Max value depend if metric support narrow + or wide value). -.. cfgcmd:: set protocols isis <name> interface <interface> network +.. cfgcmd:: set protocols isis interface <interface> network point-to-point - This command specifies network type to ‘Point-to-Point’. The default network - type is broadcast. + This command specifies network type to Point-to-Point. The default + network type is broadcast. -.. cfgcmd:: set protocols isis <name> interface <interface> passive +.. cfgcmd:: set protocols isis interface <interface> passive This command configures the passive mode for this interface. -.. cfgcmd:: set protocols isis <name> interface <interface> password +.. cfgcmd:: set protocols isis interface <interface> password plaintext-password <text> This command configures the authentication password for the interface. -.. cfgcmd:: set protocols isis <name> interface <interface> priority <number> +.. cfgcmd:: set protocols isis interface <interface> priority <number> This command sets priority for the interface for :abbr:`DIS (Designated Intermediate System)` election. The priority range is 0 to 127. -.. cfgcmd:: set protocols isis <name> interface <interface> psnp-interval +.. cfgcmd:: set protocols isis interface <interface> psnp-interval <number> This command sets PSNP interval in seconds. The interval range is 0 to 127. -.. cfgcmd:: set protocols isis <name> interface <interface> +.. cfgcmd:: set protocols isis interface <interface> no-three-way-handshake This command disables Three-Way Handshake for P2P adjacencies which described in :rfc:`5303`. Three-Way Handshake is enabled by default. -Redistribution Configuration ----------------------------- +Route Redistribution +-------------------- -.. cfgcmd:: set protocols isis <name> redistribute ipv4 <route source> level-1 +.. cfgcmd:: set protocols isis redistribute ipv4 <route source> level-1 This command redistributes routing information from the given route source into the ISIS database as Level-1. There are six modes available for route source: bgp, connected, kernel, ospf, rip, static. -.. cfgcmd:: set protocols isis <name> redistribute ipv4 <route source> level-2 +.. cfgcmd:: set protocols isis redistribute ipv4 <route source> level-2 This command redistributes routing information from the given route source into the ISIS database as Level-2. There are six modes available for route source: bgp, connected, kernel, ospf, rip, static. - -.. cfgcmd:: set protocols isis <name> redistribute ipv4 <route source> + +.. cfgcmd:: set protocols isis redistribute ipv4 <route source> <level-1|level-2> metric <number> This command specifies metric for redistributed routes from the given route source. There are six modes available for route source: bgp, connected, kernel, ospf, rip, static. The metric range is 1 to 16777215. -.. cfgcmd:: set protocols isis <name> redistribute ipv4 <route source> +.. cfgcmd:: set protocols isis redistribute ipv4 <route source> <level-1|level-2> route-map <name> This command allows to use route map to filter redistributed routes from @@ -210,15 +211,15 @@ Redistribution Configuration bgp, connected, kernel, ospf, rip, static. -Timers Configuration --------------------- +Timers +------ -.. cfgcmd:: set protocols isis <name> lsp-gen-interval <seconds> +.. cfgcmd:: set protocols isis lsp-gen-interval <seconds> This command sets minimum interval in seconds between regenerating same LSP. The interval range is 1 to 120. - -.. cfgcmd:: set protocols isis <name> lsp-refresh-interval <seconds> + +.. cfgcmd:: set protocols isis lsp-refresh-interval <seconds> This command sets LSP refresh interval in seconds. IS-IS generates LSPs when the state of a link changes. However, to ensure that routing @@ -227,32 +228,32 @@ Timers Configuration the state of the links. The interval range is 1 to 65235. The default value is 900 seconds. -.. cfgcmd:: set protocols isis <name> max-lsp-lifetime <seconds> +.. cfgcmd:: set protocols isis max-lsp-lifetime <seconds> This command sets LSP maximum LSP lifetime in seconds. The interval range is 350 to 65535. LSPs remain in a database for 1200 seconds by default. If they are not refreshed by that time, they are deleted. You can change the LSP refresh interval or the LSP lifetime. The LSP refresh interval should be less than the LSP lifetime or else LSPs will time out before - they are refreshed. - -.. cfgcmd:: set protocols isis <name> spf-interval <seconds> + they are refreshed. + +.. cfgcmd:: set protocols isis spf-interval <seconds> This command sets minimum interval between consecutive SPF calculations in seconds.The interval range is 1 to 120. -.. cfgcmd:: set protocols isis <name> spf-delay-ietf holddown <milliseconds> +.. cfgcmd:: set protocols isis spf-delay-ietf holddown <milliseconds> -.. cfgcmd:: set protocols isis <name> spf-delay-ietf init-delay +.. cfgcmd:: set protocols isis spf-delay-ietf init-delay <milliseconds> -.. cfgcmd:: set protocols isis <name> spf-delay-ietf long-delay +.. cfgcmd:: set protocols isis spf-delay-ietf long-delay <milliseconds> -.. cfgcmd:: set protocols isis <name> spf-delay-ietf short-delay +.. cfgcmd:: set protocols isis spf-delay-ietf short-delay <milliseconds> -.. cfgcmd:: set protocols isis <name> spf-delay-ietf time-to-learn +.. cfgcmd:: set protocols isis spf-delay-ietf time-to-learn <milliseconds> This commands specifies the Finite State Machine (FSM) intended to @@ -260,8 +261,9 @@ Timers Configuration to IGP events. The process described in :rfc:`8405`. -Configuration Example ---------------------- +******* +Example +******* Simple IS-IS configuration using 2 nodes and redistributing connected interfaces. @@ -278,9 +280,9 @@ interfaces. set policy route-map EXPORT-ISIS rule 10 action 'permit' set policy route-map EXPORT-ISIS rule 10 match ip address prefix-list 'EXPORT-ISIS' - set protocols isis FOO interface eth1 - set protocols isis FOO net '49.0001.1921.6800.1002.00' - set protocols isis FOO redistribute ipv4 connected level-2 route-map 'EXPORT-ISIS' + set protocols isis interface eth1 + set protocols isis net '49.0001.1921.6800.1002.00' + set protocols isis redistribute ipv4 connected level-2 route-map 'EXPORT-ISIS' **Node 2:** @@ -288,14 +290,14 @@ interfaces. set interfaces ethernet eth1 address '192.0.2.2/24' - set protocols isis FOO interface eth1 - set protocols isis FOO net '49.0001.1921.6800.2002.00' + set protocols isis interface eth1 + set protocols isis net '49.0001.1921.6800.2002.00' Show ip routes on Node2: .. code-block:: none - vyos@r2:~$ show ip route isis + vyos@r2:~$ show ip route isis Codes: K - kernel route, C - connected, S - static, R - RIP, O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 1f1e2aa9..0c6dcbd9 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -4,7 +4,7 @@ HTTP-API ######## -VyOS provide a HTTP API. You can use it to execute op-mode commands, +VyOS provides an HTTP API. You can use it to execute op-mode commands, update VyOS, set or delete config. Please take a look at the :ref:`vyosapi` page for an detailed how-to. @@ -15,7 +15,7 @@ Configuration .. cfgcmd:: set service https api keys id <name> key <apikey> - Set an named api key, every key have the same, full permissions + Set a named api key, every key has the same, full permissions on the system. .. cfgcmd:: set service https api debug @@ -25,7 +25,7 @@ Configuration .. cfgcmd:: set service https api port - Set the listen port of the local API, this have non effect of the + Set the listen port of the local API, this has no effect on the webserver. The default is port 8080 .. cfgcmd:: set service https api strict @@ -46,7 +46,7 @@ Configuration .. cfgcmd:: set service https api-restrict virtual-host <vhost> - Nginx exposes the local API on all virtual servers, by default + Nginx exposes the local API on all virtual servers, by default. Use this to restrict nginx to one or more virtual hosts. .. cfgcmd:: set service https certificates certbot domain-name <text> @@ -71,14 +71,15 @@ Configuration Example Configuration ********************* -Set an API-KEY is the minimal configuration to get a working API Endpoint. +Setting an API-KEY is the minimal configuration needed to get a working API +Endpoint. .. code-block:: none set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY -To use this full configuration we asume a publice accessable hostname. +To use this full configuration we asume a globally resolvable hostname. .. code-block:: none @@ -88,4 +89,4 @@ To use this full configuration we asume a publice accessable hostname. set service https virtual-host rtr01 listen-address 198.51.100.2 set service https virtual-host rtr01 listen-port 11443 set service https virtual-host rtr01 server-name rtr01.example.com - set service https api-restrict virtual-host rtr01.example.com
\ No newline at end of file + set service https api-restrict virtual-host rtr01.example.com diff --git a/docs/configuration/service/pppoe-server.rst b/docs/configuration/service/pppoe-server.rst index 8d895f9d..ad99cec0 100644 --- a/docs/configuration/service/pppoe-server.rst +++ b/docs/configuration/service/pppoe-server.rst @@ -388,6 +388,7 @@ The example below covers a dual-stack configuration via pppoe-server. set service pppoe-server client-ip-pool stop '192.168.0.10' set service pppoe-server client-ipv6-pool delegate '2001:db8:8003::/48' delegation-prefix '56' set service pppoe-server client-ipv6-pool prefix '2001:db8:8002::/48' mask '64' + set service pppoe-server ppp-options ipv6 allow set service pppoe-server name-server '10.1.1.1' set service pppoe-server name-server '2001:db8:4860::8888' set service pppoe-server interface 'eth2' diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index 2a55b775..1977bf7f 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -1,3 +1,5 @@ +:lastproofread: 2022-02-01 + .. _snmp: #### @@ -129,7 +131,7 @@ sent in clear text between a manager and agent. Each SNMPv3 message contains security parameters which are encoded as an octet string. The meaning of these security parameters depends on the security model being used. -The securityapproach in v3 targets: +The security approach in v3 targets: * Confidentiality – Encryption of packets to prevent snooping by an unauthorized source. @@ -161,7 +163,7 @@ Example set service snmp v3 view default oid 1 After commit the plaintext passwords will be hashed and stored in your -configuration. The resulting LCI config will look like: +configuration. The resulting CLI config will look like: .. code-block:: none @@ -201,7 +203,7 @@ VyOS MIBs All SNMP MIBs are located in each image of VyOS here: ``/usr/share/snmp/mibs/`` -you are be able to download the files with the a activate ssh service like this +You can download the file to your local host with an active ssh service like this .. code-block:: none @@ -270,4 +272,4 @@ following content: .. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 .. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 -.. start_vyoslinter
\ No newline at end of file +.. start_vyoslinter diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst index 24881186..e03d1e70 100644 --- a/docs/configuration/service/ssh.rst +++ b/docs/configuration/service/ssh.rst @@ -127,8 +127,8 @@ Operation .. opcmd:: generate ssh client-key /path/to/private_key - Re-generated a known pub/private keyfile which can e.g. used to connect to - other services (RPKI cache). + Re-generated a known pub/private keyfile which can be used to connect to + other services (e.g. RPKI cache). Example: @@ -153,5 +153,36 @@ Operation | =.. o=.oo| +----[SHA256]-----+ - Two new files ``/config/auth/id_rsa_rpki`` and ``/config/auth/id_rsa_rpki.pub`` + Two new files ``/config/auth/id_rsa_rpki`` and + ``/config/auth/id_rsa_rpki.pub`` will be created. + +.. opcmd:: generate public-key-command name <username> path <location> + + Generate the configuration mode commands to add a public key for + :ref:`ssh_key_based_authentication`. + ``<location>`` can be a local path or a URL pointing at a remote file. + + Supported remote protocols are FTP, FTPS, HTTP, HTTPS, SCP/SFTP and TFTP. + + Example: + + .. code-block:: none + + alyssa@vyos:~$ generate public-key-command name alyssa path sftp://example.net/home/alyssa/.ssh/id_rsa.pub + # To add this key as an embedded key, run the following commands: + configure + set system login user alyssa authentication public-keys alyssa@example.net key AAA... + set system login user alyssa authentication public-keys alyssa@example.net type ssh-rsa + commit + save + exit + + ben@vyos:~$ generate public-key-command user ben path ~/.ssh/id_rsa.pub + # To add this key as an embedded key, run the following commands: + configure + set system login user ben authentication public-keys ben@vyos key AAA... + set system login user ben authentication public-keys ben@vyos type ssh-dss + commit + save + exit diff --git a/docs/configuration/system/ipv6.rst b/docs/configuration/system/ipv6.rst index cba5c0e0..763b834c 100644 --- a/docs/configuration/system/ipv6.rst +++ b/docs/configuration/system/ipv6.rst @@ -10,6 +10,9 @@ System configuration commands Use this command to disable assignment of IPv6 addresses on all interfaces. + .. note:: This command is deprecated in VyOS 1.3 (equuleus) and removed in + VyOS 1.4 (sagitta). IPv6 address family can no longer be disabled. + .. cfgcmd:: set system ipv6 disable-forwarding Use this command to disable IPv6 forwarding on all interfaces. diff --git a/docs/configuration/system/login.rst b/docs/configuration/system/login.rst index 61201de7..08746201 100644 --- a/docs/configuration/system/login.rst +++ b/docs/configuration/system/login.rst @@ -84,6 +84,10 @@ The third part is simply an identifier, and is for your own reference. .. cfgcmd:: loadkey <username> <location> + **Deprecation notice:** ``loadkey`` has been deprecated in favour of + :opcmd:`generate public-key-commands` and will be removed in a future + version. See :ref:`ssh`. + SSH keys can not only be specified on the command-line but also loaded for a given user with `<username>` from a file pointed to by `<location>.` Keys can be either loaded from local filesystem or any given remote location diff --git a/docs/configuration/vpn/index.rst b/docs/configuration/vpn/index.rst index abaca198..b90dc90a 100644 --- a/docs/configuration/vpn/index.rst +++ b/docs/configuration/vpn/index.rst @@ -1,3 +1,5 @@ +.. _vpn: + ### VPN ### diff --git a/docs/configuration/vrf/index.rst b/docs/configuration/vrf/index.rst index 9b48668a..7091b51a 100644 --- a/docs/configuration/vrf/index.rst +++ b/docs/configuration/vrf/index.rst @@ -214,7 +214,7 @@ Operation ========= It is not sufficient to only configure a VRF but VRFs must be maintained, too. -For VR Fmaintenance the followin operational commands are in place. +For VRF maintenance, the following operational commands are in place. .. opcmd:: show vrf diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index cf2db021..7ba2a976 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -34,14 +34,56 @@ Docker Installing Docker_ and prerequisites: -.. code-block:: none - $ sudo apt-get update - $ sudo apt-get install -y apt-transport-https ca-certificates curl gnupg2 software-properties-common - $ curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add - - $ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable" - $ sudo apt-get update - $ sudo apt-get install -y docker-ce +`On Debian`_ + +.. code-block:: bash + + sudo apt-get update + sudo apt-get install -y apt-transport-https ca-certificates curl gnupg2 software-properties-common + curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add - + sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable" + sudo apt-get update + sudo apt-get install -y docker-ce + +`On Ubuntu`_ + +.. code-block:: bash + + sudo apt-get update + sudo apt-get -y install \ + ca-certificates \ + curl \ + gnupg \ + lsb-release + curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg + echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + sudo apt-get update + sudo apt-get install docker-ce docker-ce-cli containerd.io + + +`On Fedora`_ + +.. code-block:: bash + + sudo dnf -y install dnf-plugins-core + sudo dnf config-manager \ + --add-repo \ + https://download.docker.com/linux/fedora/docker-ce.repo + sudo dnf install -y docker-ce docker-ce-cli containerd.io + +`On CentOS and similar`_ + +.. code-block:: bash + + sudo yum install -y yum-utils + sudo yum-config-manager \ + --add-repo \ + https://download.docker.com/linux/centos/docker-ce.repo + sudo yum install -y docker-ce docker-ce-cli containerd.io + To be able to use Docker_ without ``sudo``, the current non-root user must be added to the ``docker`` group by calling: ``sudo usermod -aG docker @@ -112,6 +154,7 @@ Add the following to your ``.bash_aliases`` file: .. code-block:: none + # latest release alias vybld='docker pull vyos/vyos-build:current && docker run --rm -it \ -v "$(pwd)":/vyos \ -v "$HOME/.gitconfig":/etc/gitconfig \ @@ -121,7 +164,8 @@ Add the following to your ``.bash_aliases`` file: -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) \ vyos/vyos-build:current bash' - alias vybld='docker pull vyos/vyos-build:equuleus && docker run --rm -it \ + # v1.3 + alias vybld_equuleus='docker pull vyos/vyos-build:equuleus && docker run --rm -it \ -v "$(pwd)":/vyos \ -v "$HOME/.gitconfig":/etc/gitconfig \ -v "$HOME/.bash_aliases":/home/vyos_bld/.bash_aliases \ @@ -130,6 +174,7 @@ Add the following to your ``.bash_aliases`` file: -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) \ vyos/vyos-build:equuleus bash' + # v1.2 alias vybld_crux='docker pull vyos/vyos-build:crux && docker run --rm -it \ -v "$(pwd)":/vyos \ -v "$HOME/.gitconfig":/etc/gitconfig \ @@ -139,7 +184,7 @@ Add the following to your ``.bash_aliases`` file: -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) \ vyos/vyos-build:crux bash' -Now you are prepared with three new aliases ``vybld`` `vybld_equuleus`` and +Now you are prepared with three new aliases ``vybld``, ``vybld_equuleus``, and ``vybld_crux`` to spawn your development containers in your current working directory. @@ -800,6 +845,9 @@ information. .. _VyOS DockerHub organisation: https://hub.docker.com/u/vyos .. _repository: https://github.com/vyos/vyos-build .. _VyOS GitHub project: https://github.com/vyos - +.. _`On Debian`: https://docs.docker.com/engine/install/debian/ +.. _`On Ubuntu`: https://docs.docker.com/engine/install/ubuntu/ +.. _`On Fedora`: https://docs.docker.com/engine/install/fedora/ +.. _`On CentOS and similar`: https://docs.docker.com/engine/install/centos/ .. start_vyoslinter diff --git a/docs/documentation.rst b/docs/documentation.rst index 5161f773..a89b6079 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -89,7 +89,7 @@ access to the official codebase. for writing our docs. Additional directives how to write in RST can be obtained from reStructuredTextDirectives_. -* Check your changes by locally building the documentation ``$ make html``. +* Check your changes by locally building the documentation ``$ make livehtml``. Sphinx will build the html files in the ``docs/_build`` folder. We provide you with a Docker container for an easy to use user experience. Check the README.md_ file of this repository. diff --git a/docs/index.rst b/docs/index.rst index f81adfc8..0fc7ee80 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,53 @@ VyOS User Guide ############### +.. panels:: + :container: container-lg pb-3 + :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + + Get / Build VyOS + ^^^^^^^^^^^^^^^^ + Quickly :ref:`Build<build>` your own Image or take a look at how to :ref:`download<download>` a free or supported version. + --- + + Install VyOS + ^^^^^^^^^^^^ + Read about how to install VyOS on :ref:`Bare Metall<installation>` or in a + :ref:`Virtual Environment<virtual_env>` and + how to use an image with the usual :ref:`cloud<cloud_env>` providers + --- + + Configuration and Operation + ^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Use the :ref:`Quickstart Guide<quick-start>`, to have a fast overview. Or go deeper and + set up :ref:`advanced routing<protocols>`, + :ref:`VRFs<vrf>`, or + :ref:`VPNs<vpn>` for example. + --- + + Automate + ^^^^^^^^ + Integrate VyOS in your automation Workflow with + :ref:`Ansible<vyos-ansible>`, + have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`. + --- + + Examples + ^^^^^^^^ + Get some inspiration from the :ref:`Configuration Blueprints<examples>` + to build your infrastructure. + --- + + Contribute and Community + ^^^^^^^^^^^^^^^^^^^^^^^^ + | There are many ways to contribute to the project. + | Add missing parts or improve the :ref:`Documentation<documentation>`. + | Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_. + | Or you can pick up a `Task <https://phabricator.vyos.net/>`_ and fix the :ref:`code<development>`. + + .. toctree:: + :hidden: :maxdepth: 1 introducing/about @@ -14,7 +60,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: First Steps installation/index @@ -23,7 +69,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: Adminguide @@ -36,7 +82,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: Development contributing/index diff --git a/docs/installation/cloud/index.rst b/docs/installation/cloud/index.rst index 5236f092..0df0de04 100644 --- a/docs/installation/cloud/index.rst +++ b/docs/installation/cloud/index.rst @@ -1,3 +1,5 @@ +.. _cloud_env: + ################################## Running VyOS in Cloud Environments ################################## diff --git a/docs/installation/install.rst b/docs/installation/install.rst index a4a91606..3fda6d53 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -48,6 +48,8 @@ The minimum system requirements are 512 MiB RAM and 2 GiB storage. Depending on your use you might need additional RAM and CPU resources e.g. when having multiple BGP full tables in your system. +.. _download: + Download ======== diff --git a/docs/installation/virtual/index.rst b/docs/installation/virtual/index.rst index 808439c7..45709a8e 100644 --- a/docs/installation/virtual/index.rst +++ b/docs/installation/virtual/index.rst @@ -1,3 +1,5 @@ +.. _virtual_env: + #################################### Running VyOS in Virtual Environments #################################### diff --git a/docs/introducing/history.rst b/docs/introducing/history.rst index 9a13e2b3..054eecd6 100644 --- a/docs/introducing/history.rst +++ b/docs/introducing/history.rst @@ -4,44 +4,126 @@ History ####### -VyOS is a Linux-based network operating system that provides software-based -network routing, firewall, and VPN functionality. - -The VyOS project was started in late 2013 as a community fork of the -`GPL <https://en.wikipedia.org/wiki/GNU_General_Public_License>`_ portions of -Vyatta Core 6.6R1 with the goal of maintaining a free and open source network -operating system in response to the decision to discontinue the community -edition of Vyatta. Here everyone loves learning, older managers and new users. - -VyOS is primarily based on `Debian GNU/Linux <https://www.debian.org/>`_ and -the `Quagga <http://www.nongnu.org/quagga/>`_ routing engine. Its configuration -syntax and :ref:`cli` are loosely derived from Juniper JUNOS as modelled by the -`XORP project <http://www.xorp.org/>`_, which was the original routing engine -for Vyatta. - -In the 4.0 release of Vyatta, the routing engine was changed to Quagga. As of -VyOS version 1.2, VyOS now uses `FRRouting <https://frrouting.org/>`_ as the -routing engine. - -How is VyOS different from any other router distributions and platform? - -- It's more than just a firewall and VPN, VyOS includes extended routing - capabilities like OSPFv2, OSPFv3, BGP, VRRP, and extensive route policy - mapping and filtering -- Unified command line interface in the style of hardware routers. -- Scriptable CLI -- Stateful configuration system: prepare changes and commit at once or discard, - view previous revisions or rollback to them, archive revisions to remote - server and execute hooks at commit time -- Image-based upgrade: keep multiple versions on the same system and revert to - previous image if a problem arises -- Multiple VPN capabilities: OpenVPN, IPSec, Wireguard, DPMVPN, IKEv2 and more -- DHCP, TFTP, mDNS repeater, broadcast relay and DNS forwarding support -- Both IPv4 and IPv6 support -- Runs on physical and virtual platforms alike: small x86 boards, big servers, - KVM, Xen, VMware, Hyper-V, and more -- Completely free and open source, with documented internal APIs and build - procedures -- Community driven. Patches are welcome and all code, bugs, and nightly builds - are publicly accessible +In the beginning... +=================== +There once was a network operating system based on Debian GNU/Linux, +called Vyatta. [*]_ 2006 onwards, it was a great free software +alternative to Cisco IOS and Jupiter JUNOS. It came in two editions: +Vyatta Core (previously Vyatta Community Edition) that was completely +free software, and Vyatta Subscription Edition that had proprietary +features and was only available to paying customers. [*]_ + +Vyatta was acquired by Brocade Communication Systems in 2012. Shortly +after, Brocade renamed Vyatta Subscription Edition to Brocade vRouter, +discontinued Vyatta Core and shut down the community forum without a +notice. The bug tracker and Git repositories followed next year. + +It's worth noting that by the time Brocade acquired Vyatta, +development of Vyatta Core was already stagnated. Vyatta Subscription +Edition (and thus, Vyatta development as a whole) had been replacing +core components with proprietary software, meaning few features made +it to Vyatta Core, and those that did were bug-ridden and hamstrung. + +In 2013, soon after Vyatta Core was abandoned, the community forked +the last Vyatta Core version (6.6R1) and VyOS Project came into being. +`Sentrium SL <https://blog.vyos.io/sentrium-what-sentrium>`_ was +established by VyOS maintainers in 2014 to fund VyOS development by +selling support, consulting services and prebuilt long-term support +images. + +Brocade was acquired by Broadcom in 2016 and sold what remains of +erstwhile Vyatta to AT&T in 2017, who in turn sold it to Ciena in 2021. + + +Major releases +============== + +VyOS major versions used to be named after elements in order of atomic +numbers. With 1.2, this naming scheme was replaced with the much +cooler scheme of Latin names of IAU designated constellations by solid +angle area, starting from the smallest. + +Hydrogen (1.0) +-------------- + +Released just in time for holidays on 22 December 2013, Hydrogen was +the first major VyOS release. It fixed features that were broken in +Vyatta Core 6.6 (such as IPv4 BGP peer groups and DHCPv6 relay) and +introduced command scripting, a task scheduler and web proxy LDAP +authentication. + +Helium (1.1) +------------ + +Helium was released on 9 October 2014, exactly on the day VyOS Project +first came into being in the previous year. Helium came with a lot of +new features, including an event handler and support for L2TPv3, +802.1ad QinQ and IGMP proxy, as well as experimental support for VXLAN +and DMVPN (the latter of which was also broken in Vyatta Core due to +its reliance on a proprietary NHRP implementation). + +Crux (1.2) +---------- + +Crux (the Southern Cross) came out on 28 January 2019 and was the +first major release of VyOS as we know it today. The underlying +Debian base was upgraded from Squeeze (6) to Jessie (8). + +Although Crux came with too many new features to mention here, some +noteworthy ones are: an mDNS repeater, a broadcast relay, +a high-performance PPPoE server, an HFSC scheduler, as well as support +for Wireguard, unicast VRRP, RPKI for BGP and fully 802.1ad-compliant +QinQ ethertype. The telnet server and support for P2P filtering were +removed. + +Crux is the first version to feature the modular image build system. +CLI definitions began to be written in the modern, verifiable XML +templates. Python APIs were introduced for command scripting and +configuration migration. Introduction of new Perl and shell code was +proscribed and the rewriting of legacy Perl code in pure Python began +with Crux. + +As of 2022, Crux is still supported and maintained. + +Equuleus (1.3) +-------------- + +The current long-term support version of VyOS, Equuleus (the Pony) +came out on 21 December 2021, once again in time for the winter +holidays. + +Equuleus brought many long-desired features with it, most notably +an SSTP VPN server, an IPoE server, an OpenConnect VPN server and +a serial console server, in addition to reworked support for WWAN +interfaces, support for GENEVE and MACSec interfaces, VRF, IS-IS +routing, preliminary support for MPLS and LDP, and many other +initialisms. + +As of 2022, Equuleus is in the stable. + +Sagitta (1.4) +------------- + +Sagitta (the Arrow) is the codename of the current development +branch, so there's no VyOS 1.4 yet. + +A note on copyright +=================== + +Unlike Vyatta, VyOS never had (nor will ever have) proprietary code. +The only proprietary material in VyOS is non-code assets, such as +graphics and the trademark "VyOS". [*]_ This means you can build your +own long-term support images (as the entire toolchain we use is free +software) and even distribute them, given you rename it and remove +such assets before building. Although note that we do not provide +support for images distributed by a third-party. See the +`artwork license <https://github.com/vyos/vyos-build/blob/current/LICENSE.artwork>`_ +and the end-user license agreement at ``/usr/share/doc/vyos/EULA`` in +any pre-built image for more precise information. + + +.. [*] From the Sanskrit adjective "Vyātta" (व्यात्त), meaning opened. +.. [*] A business model comparable to that of Redis, rather than that + of VyOS today. +.. [*] This is not unlike how Linus Torvalds owns the trademark "Linux". diff --git a/docs/operation/index.rst b/docs/operation/index.rst index c19afeab..e1414b3c 100644 --- a/docs/operation/index.rst +++ b/docs/operation/index.rst @@ -7,4 +7,5 @@ Operation Mode :includehidden: information - boot-options
\ No newline at end of file + boot-options + raid
\ No newline at end of file diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst new file mode 100644 index 00000000..30407718 --- /dev/null +++ b/docs/operation/raid.rst @@ -0,0 +1,245 @@ +.. _raid: + +###### +RAID-1 +###### + +A Redundant Array of Independent Disks (RAID) uses two or more hard disk drives +to improve disk speed, store more data, and/or provide fault tolerance. +There are several storage schemes possible in a RAID array, each offering a +different combination of storage, reliability, and/or performance. +The VyOS system supports a “RAID 1” deployment. RAID 1 allows two or more +disks to mirror one another to provide system fault tolerance. In a RAID 1 +solution, every sector of one disk is duplicated onto every sector of all +disks in the array. Provided even one disk in the RAID 1 set is operational, +the system continues to run, even through disk replacement (provided that the +hardware supports in-service replacement of drives). +RAID 1 can be implemented using special hardware or it can be implemented in +software. The VyOS system supports software RAID 1 on two disks. +The VyOS implementation of RAID 1 allows the following: + +* Detection and reporting of disk failure +* The ability to maintain system operation with one failed disk +* The ability to boot the system with one failed disk +* The ability to replace a failed disk and initiate re-mirroring +* The ability to monitor the status of remirroring + +.. _raid_instalation: + +Installation Implications +========================= + +The VyOS systems installation utility provides several options for installing +to a RAID 1 set. You can: + +* Use the install system to create the RAID 1 set +* Use the underlying Linux commands to create a RAID 1 set before running the + install system command. +* Use a previously-created RAID 1 set. + +.. note:: Before a permanent installation, VyOS runs a live installation + +Configuration +============= + +Single disk, install as normal +------------------------------ + +When the VyOS system is installed, it automatically detects the presence of two +disks not currently part of a RAID array. In these cases, the VyOS +installation utility automatically offers you the option of configuring RAID 1 +mirroring for the drives, with the following prompt. + +.. code-block:: none + + Would you like to configure RAID 1 mirroring on them? + +* If you do not want to configure RAID 1 mirroring, enter “No” at the prompt + and continue with installation in the normal way. + +Empty 2+ Disk +------------- + +If VyOS system detect two identical disks that are not currently part of a +RAID-1 set, the VyOS installation utility automatically offers you the option +of configuring RAID 1 mirroring for the drives, with the following prompt. + +.. code-block:: none + + Would you like to configure RAID 1 mirroring on them? + +1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system +detects a filesystem on the partitions being used for RAID 1 it will prompt you +to indicate whether you want to continue creating the RAID 1 array. + +.. code-block:: none + + Continue creating array? + +2 - To overwrite the old filesystem, enter “Yes”. + +3 - The system informs you that all data on both drives will be erased. You are +prompted to confirm that you want to continue + +.. code-block:: none + + Are you sure you want to do this? + +4 - Enter “Yes” at the prompt to retain the current VyOS configuration once +installation is complete. Enter “No” to delete the current VyOS +configuration. + +.. code-block:: none + + Would you like me to save the data on it before I delete it? + +5 - Enter “Yes” at the prompt to retain the current VyOS configuration once +installation is complete. Enter “No” to delete the current VyOS configuration. + +6 - Continue with installation in the normal way. + + +Present RAID-1 +-------------- + +When the VyOS software on a system with a RAID 1 set already configured, +the installation utility will detect the array and will display the following +prompt: + +.. code-block:: none + + Would you like to use this one? + +1 - To break apart the current RAID 1 set, enter “No” at the prompt. The + +installation utility detects that there are two identical disks and offers you +the option of configuring RAID 1 mirroring on them, displaying the following +prompt: + +.. code-block:: none + + Would you like to configure RAID 1 mirroring on them? + +2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” +at the prompt. The system prompts you to indicate which partition you would +like the system installed on. + +.. code-block:: none + + Which partition should I install the root on? [sda1]: + +3 - Enter the partition where you would like the system installed. The system +then prompts you to indicate whether you want to save the old configuration +data. This represents the current VyOS configuration. + +.. code-block:: none + + Would you like me to save the data on it before I delete it? + +4 - Enter “Yes” at the prompt to retain the current VyOS configuration once +installation is complete. Enter “No” to delete the current VyOS configuration. + +5 - Continue with installation in the normal way. + + +Detecting and Replacing a Failed RAID 1 Disk +-------------------------------------------- + +The VyOS system automatically detects a disk failure within a RAID 1 set and +reports it to the system console. You can verify the failure by issuing the +show raid command. + +To replace a bad disk within a RAID 1 set, perform the following steps: + +1 - Remove the failed disk from the RAID 1 set by issuing the following +command: + +.. opcmd:: delete raid <RAID‐1‐device> member <disk‐partition> + + where RAID-1-device is the name of the RAID 1 device (for example, md0) and + disk-partition is the name of the failed disk partition (for example, sdb2). + +2- Physically remove the failed disk from the system. If the drives are not +hot-swappable, then you must shut down the system before removing the disk. + +3 - Replace the failed drive with a drive of the same size or larger. + +4 - Format the new disk for RAID 1 by issuing the following command: + +.. opcmd:: format disk <disk‐device1> like <disk‐device2> + + where disk-device1 is the replacement disk (for example, sdb) and + disk-device2 is the existing healthy disk (for example, sda). + +5-Add the replacement disk to the RAID 1 set by issuing the following command: + +.. opcmd:: add raid <RAID‐1‐device> member <disk‐partition> + + where RAID-1-device is the name of the RAID 1 device (for example, md0) and + disk-partition is the name of the replacement disk partition + (for example, sdb2). + +Operation +========= + +This part introduces how to add a disk partition to a RAID-1 set initiates +mirror synchronization, check and display information. + +.. opcmd:: add raid <RAID‐1‐device> member <disk‐partition> + + Use this command to add a member disk partition to the RAID 1 set. Adding a + disk partition to a RAID 1 set initiates mirror synchronization, where all + data on the existing member partition is copied to the new partition. + +.. opcmd:: format disk <disk‐device1> like <disk‐device2> + + This command is typically used to prepare a disk to be added to a preexisting + RAID 1 set (of which disk-device2 is already a member). + +.. opcmd:: show raid <RAID‐1‐device> + + shows output for show raid md0 as sdb1 is being added to the RAID 1 + set and is in the process of being resynchronized. + + .. code-block:: none + + vyos@vyos:~$ show raid md0 + /dev/md0: + Version : 00.90 + Creation Time : Wed Oct 29 09:19:09 2008 + Raid Level : raid1 + Array Size : 1044800 (1020.48 MiB 1069.88 MB) + Used Dev Size : 1044800 (1020.48 MiB 1069.88 MB) + Raid Devices : 2 + Total Devices : 2 + Preferred Minor : 0 + Persistence : Superblock is persistent + Update Time : Wed Oct 29 19:34:23 2008 + State : active, degraded, recovering + Active Devices : 1 + Working Devices : 2 + Failed Devices : 0 + Spare Devices : 1 + Rebuild Status : 17% complete + UUID : 981abd77:9f8c8dd8:fdbf4de4:3436c70f + Events : 0.103 + Number Major Minor RaidDevice State + 0 8 1 0 active sync /dev/sda1 + 2 8 17 1 spare rebuilding /dev/sdb1 + +.. opcmd:: show raid <RAID‐1‐device> + + Use this command to display the formatting of a hard disk. + + .. code-block:: none + + vyos@vyos:~$ show disk sda format + Disk /dev/sda: 1073 MB, 1073741824 bytes + 85 heads, 9 sectors/track, 2741 cylinders + Units = cylinders of 765 * 512 = 391680 bytes + Disk identifier: 0x000b7179 + Device Boot Start End Blocks Id System + /dev/sda1 6 2737 1044922+ fd Linux raid autodetect + + + diff --git a/requirements.txt b/requirements.txt index 7bb02202..61441cfc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -Sphinx>=1.4.3 -sphinx-rtd-theme -setuptools -docutils -lxml -sphinx-notfound-page -docutils<0.18 +Sphinx==4.5.0 +sphinx-rtd-theme==1.0.0 +sphinx-autobuild==2021.3.14 +sphinx-notfound-page==0.8 +lxml==4.8.0 +myst-parser==0.17.1 +sphinx-panels==0.6.0 diff --git a/vale.ini b/vale.ini deleted file mode 100644 index b7dde1d8..00000000 --- a/vale.ini +++ /dev/null @@ -1,16 +0,0 @@ -StylesPath = .github/styles -MinAlertLevel = suggestion - -SkippedScopes = script, style, pre, figure, img, a, code - - -[*.rst] -BasedOnStyles = VyOS, Google - -Google.DateFormat = YES -vale.GenderBias = NO -vale.Hedging = NO -vale.Redundancy = NO -vale.Repetition = YES -vale.Uncomparables = NO -proselint.GenderBias = NO
\ No newline at end of file |
