From 6e3fdd41056aa104a49b172de16d0d770afe556c Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Wed, 12 Feb 2025 17:48:57 -0500 Subject: T7153: remove logging module (#393) --- docs/vyos.vyos.vyos_logging_module.rst | 348 --------------------------------- 1 file changed, 348 deletions(-) delete mode 100644 docs/vyos.vyos.vyos_logging_module.rst (limited to 'docs') diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst deleted file mode 100644 index b29b064..0000000 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ /dev/null @@ -1,348 +0,0 @@ -.. _vyos.vyos.vyos_logging_module: - - -********************** -vyos.vyos.vyos_logging -********************** - -**Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-08-01 -:Why: Updated module released with more functionality. -:Alternative: vyos_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Vyatta Vyos devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of logging definitions.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • file
    • -
  • global
    • -
  • host
    • -
  • user
    • -
- 		-
Destination of the logs.
-
-
- facility - -
- string -
- 		- -
Set logging facility.
-
-
- level - -
- string -
- 		- -
Set logging severity levels.
-
-
- name - -
- string -
- 		- -
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • file
    • -
  • global
    • -
  • host
    • -
  • user
    • -
- 		-
Destination of the logs.
-
-
- facility - -
- string -
- 		- -
Set logging facility.
-
-
- level - -
- string -
- 		- -
Set logging severity levels.
-
-
- name - -
- string -
- 		- -
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- - -Notes ------ - -.. note:: - - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: configure console logging - vyos.vyos.vyos_logging: - dest: console - facility: all - level: crit - - - name: remove console logging configuration - vyos.vyos.vyos_logging: - dest: console - state: absent - - - name: configure file logging - vyos.vyos.vyos_logging: - dest: file - name: test - facility: local3 - level: err - - - name: Add logging aggregate - vyos.vyos.vyos_logging: - aggregate: - - dest: file - name: test1 - facility: all - level: info - - dest: file - name: test2 - facility: news - level: debug - state: present - - - name: Remove logging aggregate - vyos.vyos.vyos_logging: - aggregate: - - dest: console - facility: all - level: info - - dest: console - facility: daemon - level: warning - - dest: file - name: test2 - facility: news - level: debug - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set system syslog global facility all level notice']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2023-08-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) -- cgit v1.2.3