saltext.salt_describe.runners package

Submodules

saltext.salt_describe.runners.salt_describe module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe.all_(tgt, top=True, include=None, exclude=None, config_system='salt', **kwargs)

Run all describe methods against target.

One of either a exclude or include can be given to specify which functions to run. These can be either a string or python list.

CLI Example:

salt-run describe.all minion-tgt exclude='["file", "user"]'

You can supply args and kwargs to functions that require them as well. These are passed as explicit kwargs.

CLI Example:

salt-run describe.all minion-tgt include='["file", "pip"]' paths='["/tmp/testfile", "/tmp/testfile2"]'

If two functions take an arg or kwarg of the same name, you can differentiate them by prefixing the argument name.

CLI Example:

salt-run describe.all minion-tgt include='["file", "pip"]' file_paths='["/tmp/testfile", "/tmp/testfile2"]'

saltext.salt_describe.runners.salt_describe.top_(tgt, tgt_type='glob', env='base')

Add the generated states to top.sls

CLI Example:

salt-run describe.top minion-tgt

saltext.salt_describe.runners.salt_describe.pillar_top(tgt, tgt_type='glob', env='base')

Add the generated pillars to top.sls

CLI Example:

salt-run describe.top minion-tgt

saltext.salt_describe.runners.salt_describe_cron module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_cron.cron(tgt, user='root', include_pre=True, tgt_type='glob', config_system='salt')

Generate the state file for a user’s cron data

CLI Example:

salt-run describe.all minion-tgt user

saltext.salt_describe.runners.salt_describe_file module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_file.file(tgt, paths, tgt_type='glob', config_system='salt')

Read a file on the minions and build a state file to managed a file.

CLI Example:

salt-run describe.file minion-tgt /etc/salt/minion

saltext.salt_describe.runners.salt_describe_firewalld module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_firewalld.firewalld(tgt, tgt_type='glob', config_system='salt')

Gather the firewalld rules for minions and generate a state file.

CLI Example:

salt-run describe.firewalld minion-tgt

saltext.salt_describe.runners.salt_describe_host module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_host.host(tgt, tgt_type='glob', config_system='salt')

Gather /etc/hosts file content on minions and build a state file.

CLI Example:

salt-run describe.host minion-tgt

saltext.salt_describe.runners.salt_describe_iptables module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_iptables.iptables(tgt, tgt_type='glob', config_system='salt')

Gather the iptable rules for minions and generate a state file.

CLI Example:

salt-run describe.iptables minion-tgt

saltext.salt_describe.runners.salt_describe_pip module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_pip.pip(tgt, tgt_type='glob', bin_env=None, config_system='salt', **kwargs)

Gather installed pip libraries and build a state file.

CLI Example:

salt-run describe.pip minion-tgt

saltext.salt_describe.runners.salt_describe_pkg module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_pkg.pkg(tgt, tgt_type='glob', include_version=True, single_state=True, config_system='salt', **kwargs)

Gather installed pkgs on minions and build a state file.

CLI Example:

salt-run describe.pkg minion-tgt

salt-run describe.pkg minion-tgt config_system=ansible

salt-run describe.pkg minion-tgt config_system=chef

saltext.salt_describe.runners.salt_describe_pkgrepo module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_pkgrepo.pkgrepo(tgt, tgt_type='glob', config_system='salt')

Gather the package repo data for minions and generate a state file.

CLI Example:

salt-run describe.pkgrepo minion-tgt

saltext.salt_describe.runners.salt_describe_service module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_service.service(tgt, tgt_type='glob', config_system='salt', **kwargs)

Gather enabled and disabled services on minions and build a state file.

CLI Example:

salt-run describe.service minion-tgt

If you want to generate ansible playbooks you need to pass in config_system and hosts

salt-run describe.service minion-tgt config_system=ansible hosts=hostgroup

saltext.salt_describe.runners.salt_describe_sysctl module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_sysctl.sysctl(tgt, sysctl_items, tgt_type='glob', config_system='salt')

read sysctl on the minions and build a state file to managed the sysctl settings.

CLI Example:

salt-run describe.sysctl minion-tgt '[vm.swappiness,vm.dirty_ratio]'

saltext.salt_describe.runners.salt_describe_timezone module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_timezone.timezone(tgt, tgt_type='glob', config_system='salt')

Gather the timezone data for minions and generate a state file.

CLI Example:

salt-run describe.timezone minion-tgt

saltext.salt_describe.runners.salt_describe_user module

Module for building state file

New in version 3006.

saltext.salt_describe.runners.salt_describe_user.user(tgt, require_groups=False, minimum_uid=None, maximum_uid=None, minimum_gid=None, maximum_gid=None, tgt_type='glob', config_system='salt')

read users on the minions and build a state file to manage the users.

CLI Example:

salt-run describe.user minion-tgt

saltext.salt_describe.runners.salt_describe_user.group(tgt, include_members=False, minimum_gid=None, maximum_gid=None, tgt_type='glob', config_system='salt')

read groups on the minions and build a state file to managed th groups.

CLI Example:

salt-run describe.group minion-tgt