Page MenuHomeVyOS Platform
Files F4979241

vyos_logging.py
No OneTemporary
Actions

Size
9 KB
Referenced Files
None
Subscribers
None

vyos_logging.py
View Options

#!/usr/bin/python
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function
__metaclass__ = type
# (c) 2017, Ansible by Red Hat, inc
#
# This file is part of Ansible by Red Hat
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible 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
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
DOCUMENTATION = """
module: vyos_logging
author: Trishna Guha (@trishnaguha)
short_description: Manage logging on network devices
description:
- This module provides declarative management of logging on Vyatta Vyos devices.
version_added: 1.0.0
notes:
- Tested against VyOS 1.1.8 (helium).
- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html).
options:
dest:
description:
- Destination of the logs.
type: str
choices:
- console
- file
- global
- host
- user
name:
description:
- If value of C(dest) is I(file) it indicates file-name, for I(user) it indicates
username and for I(host) indicates the host name to be notified.
type: str
facility:
description:
- Set logging facility.
type: str
level:
description:
- Set logging severity levels.
type: str
aggregate:
description: List of logging definitions.
type: list
elements: dict
suboptions:
dest:
description:
- Destination of the logs.
type: str
choices:
- console
- file
- global
- host
- user
name:
description:
- If value of C(dest) is I(file) it indicates file-name, for I(user) it indicates
username and for I(host) indicates the host name to be notified.
type: str
facility:
description:
- Set logging facility.
type: str
level:
description:
- Set logging severity levels.
type: str
state:
description:
- State of the logging configuration.
type: str
choices:
- present
- absent
state:
description:
- State of the logging configuration.
type: str
default: present
choices:
- present
- absent
extends_documentation_fragment:
- vyos.vyos.vyos
"""
EXAMPLES = """
- 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 = """
commands:
description: The list of configuration mode commands to send to the device
returned: always
type: list
sample:
- set system syslog global facility all level notice
"""
import re
from copy import deepcopy
from ansible.module_utils._text import to_text
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.validation import check_required_if
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
remove_default_spec,
)
from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import (
get_config,
load_config,
)
from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import (
vyos_argument_spec,
)
def spec_to_commands(updates, module):
commands = list()
want, have = updates
for w in want:
dest = w["dest"]
name = w["name"]
facility = w["facility"]
level = w["level"]
state = w["state"]
del w["state"]
if state == "absent" and w in have:
if w["name"]:
commands.append(
"delete system syslog {0} {1} facility {2} level {3}".format(
dest, name, facility, level
)
)
else:
commands.append(
"delete system syslog {0} facility {1} level {2}".format(
dest, facility, level
)
)
elif state == "present" and w not in have:
if w["name"]:
commands.append(
"set system syslog {0} {1} facility {2} level {3}".format(
dest, name, facility, level
)
)
else:
commands.append(
"set system syslog {0} facility {1} level {2}".format(
dest, facility, level
)
)
return commands
def config_to_dict(module):
data = get_config(module)
obj = []
for line in data.split("\n"):
if line.startswith("set system syslog"):
match = re.search(r"set system syslog (\S+)", line, re.M)
dest = match.group(1)
if dest == "host":
match = re.search(r"host (\S+)", line, re.M)
name = match.group(1)
elif dest == "file":
match = re.search(r"file (\S+)", line, re.M)
name = match.group(1)
elif dest == "user":
match = re.search(r"user (\S+)", line, re.M)
name = match.group(1)
else:
name = None
if "facility" in line:
match = re.search(r"facility (\S+)", line, re.M)
facility = match.group(1)
if "level" in line:
match = re.search(r"level (\S+)", line, re.M)
level = match.group(1).strip("'")
obj.append(
{
"dest": dest,
"name": name,
"facility": facility,
"level": level,
}
)
return obj
def map_params_to_obj(module, required_if=None):
obj = []
aggregate = module.params.get("aggregate")
if aggregate:
for item in aggregate:
for key in item:
if item.get(key) is None:
item[key] = module.params[key]
try:
check_required_if(required_if, item)
except TypeError as exc:
module.fail_json(to_text(exc))
obj.append(item.copy())
else:
if module.params["dest"] not in ("host", "file", "user"):
module.params["name"] = None
obj.append(
{
"dest": module.params["dest"],
"name": module.params["name"],
"facility": module.params["facility"],
"level": module.params["level"],
"state": module.params["state"],
}
)
return obj
def main():
"""main entry point for module execution"""
element_spec = dict(
dest=dict(
type="str", choices=["console", "file", "global", "host", "user"]
),
name=dict(type="str"),
facility=dict(type="str"),
level=dict(type="str"),
state=dict(default="present", choices=["present", "absent"]),
)
aggregate_spec = deepcopy(element_spec)
# remove default in aggregate spec, to handle common arguments
remove_default_spec(aggregate_spec)
argument_spec = dict(
aggregate=dict(type="list", elements="dict", options=aggregate_spec)
)
argument_spec.update(element_spec)
argument_spec.update(vyos_argument_spec)
required_if = [
("dest", "host", ["name", "facility", "level"]),
("dest", "file", ["name", "facility", "level"]),
("dest", "user", ["name", "facility", "level"]),
("dest", "console", ["facility", "level"]),
("dest", "global", ["facility", "level"]),
]
module = AnsibleModule(
argument_spec=argument_spec,
required_if=required_if,
supports_check_mode=True,
)
warnings = list()
result = {"changed": False}
if warnings:
result["warnings"] = warnings
want = map_params_to_obj(module, required_if=required_if)
have = config_to_dict(module)
commands = spec_to_commands((want, have), module)
result["commands"] = commands
if commands:
commit = not module.check_mode
load_config(module, commands, commit=commit)
result["changed"] = True
module.exit_json(**result)
if __name__ == "__main__":
main()

File Metadata

Mime Type
text/x-script.python
Expires
Thu, Oct 31, 10:35 PM (1 d, 19 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
886618
Default Alt Text
vyos_logging.py (9 KB)

Event Timeline