add_alert(alertstring)

Add an alert to the collection of alerts for this plugin. These will be displayed in the report

add_cmd_output(cmds, suggest_filename=None, root_symlink=None, timeout=300, stderr=True, chroot=True, runat=None, env=None)

Run a program or a list of programs and collect the output

add_copy_spec(copyspecs, sizelimit=None, tailit=True)

Add a file or glob but limit it to sizelimit megabytes. If fname is a single file the file will be tailed to meet sizelimit. If the first file in a glob is too large it will be tailed to meet the sizelimit.

add_custom_text(text)

Append text to the custom text that is included in the report. This is freeform and can include html.

add_forbidden_path(forbidden)

Specify a path to not copy, even if it’s part of a copy_specs[] entry.

add_journal(units=None, boot=None, since=None, until=None, lines=None, allfields=False, output=None, timeout=None)

Collect journald logs from one of more units.

Keyword arguments: units – A string, or list of strings specifying the systemd

lines – The maximum number of lines to be collected. allfields – Include all journal fields regardless of size or

timeout – An optional timeout in seconds.

add_string_as_file(content, filename)

Add a string to the archive as a file named filename

archive = None

call_ext_prog(prog, timeout=300, stderr=True, chroot=True, runat=None)

Execute a command independantly of the output gathering part of sosreport.

check_enabled()

This method will be used to verify that a plugin should execute given the condition of the underlying environment.

The default implementation will return True if none of class.files, class.packages, nor class.commands is specified. If any of these is specified the plugin will check for the existence of any of the corresponding paths, packages or commands and return True if any are present.

For SCLPlugin subclasses, it will check whether the plugin can be run for any of installed SCLs. If so, it will store names of these SCLs on the plugin class in addition to returning True.

For plugins with more complex enablement checks this method may be overridden.

check_ext_prog(prog)

Execute a command independently of the output gathering part of sosreport and check the return code. Return True for a return code of 0 and False otherwise.

collect()

Collect the data for a plugin.

commands = ()

default_enabled()

This decides whether a plugin should be automatically loaded or only if manually specified in the command line.

do_cmd_output_sub(cmd, regexp, subst)

Apply a regexp substitution to command output archived by sosreport. cmd is the command name from which output is collected (i.e. excluding parameters). The regexp can be a string or a compiled re object. The substitution string, subst, is a string that replaces each occurrence of regexp in each file collected from cmd. Internally ‘cmd’ is treated as a glob with a leading and trailing ‘*’ and each matching file from the current module’s command list is subjected to the replacement.

This function returns the number of replacements made.

do_cmd_private_sub(cmd)

Remove certificate and key output archived by sosreport. cmd is the command name from which output is collected (i.e. exlcuding parameters). Any matching instances are replaced with: ‘—–SCRUBBED’ and this function does not take a regexp or substituting string.

This function returns the number of replacements made.

do_file_sub(srcpath, regexp, subst)

Apply a regexp substitution to a file archived by sosreport. srcpath is the path in the archive where the file can be found. regexp can be a regexp string or a compiled re object. subst is a string to replace each occurance of regexp in the content of srcpath.

This function returns the number of replacements made.

do_path_regex_sub(pathexp, regexp, subst)

Apply a regexp substituation to a set of files archived by sos. The set of files to be substituted is generated by matching collected file pathnames against pathexp which may be a regular expression string or compiled re object. The portion of the file to be replaced is specified via regexp and the replacement string is passed in subst.

do_regex_find_all(regex, fname)

file_grep(regexp, *fnames)

Returns lines matched in fnames, where fnames can either be pathnames to files to grep through or open file objects to grep through line by line.

files = ()

get_all_options()

return a list of all options selected

get_cmd_output_now(exe, suggest_filename=None, root_symlink=False, timeout=300, stderr=True, chroot=True, runat=None, env=None)

Execute a command and save the output to a file for inclusion in the report.

get_cmd_output_path(name=None, make=True)

Return a path into which this module should store collected command output

get_command_output(prog, timeout=300, stderr=True, chroot=True, runat=None, env=None)

get_description()

This function will return the description for the plugin

get_option(optionname, default=0)

Returns the first value that matches ‘optionname’ in parameters passed in via the command line or set via set_option or via the global_plugin_options dictionary, in that order.

optionaname may be iterable, in which case the first option that matches any of the option names is returned.

get_option_as_list(optionname, delimiter=', ', default=None)

Will try to return the option as a list separated by the delimiter.

is_installed(package_name)

Is the package $package_name installed?

is_module_loaded(module_name)

Return whether specified moudle as module_name is loaded or not

join_sysroot(path)

classmethod name()

Returns the plugin’s name as a string. This should return a lowercase string.

packages = ()

plugin_name = None

policy()

postproc()

Perform any postprocessing. To be replaced by a plugin if required.

profiles = ()

report()

Present all information that was gathered in an html file that allows browsing the results.

requires_root = True

set_option(optionname, value)

set the named option to value.

setup()

Collect the list of files declared by the plugin. This method may be overridden to add further copy_specs, forbidden_paths, and external programs if required.

setup_verify()

strip_sysroot(path)

sysroot = '/'

tmp_in_sysroot()

use_sysroot()

version = 'unversioned'

class SCLNpmPlugin(Plugin, SCLPlugin):

packages = (“%(scl_name)s-npm”,)

add_cmd_output_scl(scl, cmds, **kwargs)

Same as add_cmd_output, except that it wraps command in “scl enable” call.

add_copy_spec_limit_scl(scl, copyspec, **kwargs)

Same as add_copy_spec_limit, except that it prepends path to SCL root to “copyspec”.

add_copy_spec_scl(scl, copyspecs)

Same as add_copy_spec, except that it prepends path to SCL root to “copyspecs”.

convert_copyspec_scl(scl, copyspec)

scls_matched

add_dir(path)

add_file(src, dest=None)

add_link(source, link_name)

add_node(path, mode, device)

add_string(content, dest)

classmethod archive_type()

Returns the archive class’s name as a string.

cleanup()

Clean up any temporary resources used by an Archive class.

finalize(method)

Finalize an archive object via method. This may involve creating An archive that is subsequently compressed or simply closing an archive that supports in-line handling. If method is automatic then the following methods are tried in order: xz, bz2 and gzip

get_archive_path()

Return a string representing the path to the temporary archive. For archive classes that implement in-line handling this will be the archive file itself. Archives that use a directory based cache prior to packaging should return the path to the temporary directory where the report content is located

get_tmp_dir()

Return a temporary directory that clients of the archive may use to write content to. The content of the path is guaranteed to be included in the generated archive.

log = <logging.Logger object>

log_debug(msg)

log_error(msg)

log_info(msg)

log_warn(msg)

name_max()

Return the maximum file name length this archive can support. This is the lesser of the name length limit of the archive format and any temporary file system based cache.

set_debug(debug)

add_dir(path)

add_file(src, dest=None)

add_link(source, link_name)

add_node(path, mode, device)

add_string(content, dest)

cleanup()

dest_path(name)

finalize(method)

get_archive_path()

get_tmp_dir()

makedirs(path, mode=448)

name_max()

open_file(path)

copy_permissions_filter(tarinfo)

get_selinux_context(path)

method = None

name()

name_max()

set_tarinfo_from_stat(tar_info, fstat, mode=None)

get_msg()

PATH = '/bin:/sbin:/usr/bin:/usr/sbin'

default_runlevel()

distro = 'Linux'

get_arch()

get_local_name()

Returns the name usd in the pre_work step

get_preferred_hash_name()

host_name()

is_kernel_smp()

kernel_version()

pre_work()

sanitize_case_id(case_id)

sanitize_report_name(report_name)

vendor = 'None'

all_pkgs()

Return a list of all packages.

all_pkgs_by_name(name)

Return a list of packages that match name.

all_pkgs_by_name_regex(regex_name, flags=0)

Return a list of packages that match regex_name.

build_verify_command(self, packages) -> str

Generate a command to verify the list of packages given in packages using the native package manager’s verification tool.

The command to be executed is returned as a string that may be passed to a command execution routine (for e.g. sos_get_command_output().

chroot = None

get_pkg_list()

Returns a dictionary of packages in the following format:

{'package_name': {'name': 'package_name',


                  'version': 'major.minor.version'}}

pkg_by_name(name)

Return a single package that matches name.

pkg_nvra(pkg)

query_command = None

verify_command = None

verify_filter = None

PATH = ''

check()

This function is responsible for determining if the underlying system is supported by this policy.

del_valid_subclasses()

display_results(archive, directory, checksum)

dist_version()

Return the OS version

distro = 'Unknown'

get_archive_name()

This function should return the filename of the archive without the extension.

get_msg()

This method is used to prepare the preamble text to display to the user in non-batch mode. If your policy sets self.distro that text will be substituted accordingly. You can also override this method to do something more complicated.

get_preferred_archive()

Return the class object of the prefered archive format for this platform

get_preferred_hash_name()

Returns the string name of the hashlib-supported checksum algorithm to use

get_tmp_dir(opt_tmp_dir)

get_valid_subclasses()

host_sysroot()

in_container()

Returns True if sos is running inside a container environment.

is_root()

This method should return true if the user calling the script is considered to be a superuser

match_plugin(plugin_classes)

msg = 'This command will collect system configuration and diagnostic information from this %(distro)s system. An archive containing the collected information will be generated in %(tmpdir)s.\n\nFor more information on %(vendor)s visit:\n\n %(vendor_url)s\n\nThe generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party.\n\nNo changes will be made to system configuration.\n%(vendor_text)s\n'

pkg_by_name(pkg)

post_work()

This function is called after the sosreport has been generated.

pre_work()

This function is called prior to collection.

set_commons(commons)

set_exec_path()

set_valid_subclasses(subclasses)

valid_subclasses

list of subclasses that this policy can process

validate_plugin(plugin_class, experimental=False)

Verifies that the plugin_class should execute under this policy

vendor = 'Unknown'

vendor_text = ''

vendor_url = 'http://www.example.com/'

ADDS_TO = 'alerts'

ADDS_TO = 'commands'

ADDS_TO = 'copied_files'

ADDS_TO = 'created_files'

can_add(node)

ADDS_TO = 'notes'

ALERT = ' ! %s'

DIVIDER = '========================================================================'

LEAF = ' * %(name)s'

NOTE = ' * %s'

line_buf = []

process_subsection(section, key, header, format_)

subsections = ((<class 'sos.reporting.Command'>, ' * %(name)s', '- commands executed:'), (<class 'sos.reporting.CopiedFile'>, ' * %(name)s', '- files copied:'), (<class 'sos.reporting.CreatedFile'>, ' * %(name)s', '- files created:'), (<class 'sos.reporting.Alert'>, ' ! %s', '- alerts:'), (<class 'sos.reporting.Note'>, ' * %s', '- notes:'))

unicode()

add(*nodes)

can_add(node)

add(*nodes)

can_add(node)

get_modules()

Returns the list of importable modules in the configured python package.