INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Return the current policy for the specified table/ chain
def get_policy(table='filter', chain=None, family='ipv4'): ''' Return the current policy for the specified table/chain CLI Example: .. code-block:: bash salt '*' iptables.get_policy filter INPUT IPv6: salt '*' iptables.get_policy filter INPUT family=ipv6 ''' if not ch...
Set the current policy for the specified table/ chain
def set_policy(table='filter', chain=None, policy=None, family='ipv4'): ''' Set the current policy for the specified table/chain CLI Example: .. code-block:: bash salt '*' iptables.set_policy filter INPUT ACCEPT IPv6: salt '*' iptables.set_policy filter INPUT ACCEPT family=ip...
Save the current in - memory rules to disk
def save(filename=None, family='ipv4'): ''' Save the current in-memory rules to disk CLI Example: .. code-block:: bash salt '*' iptables.save /etc/sysconfig/iptables IPv6: salt '*' iptables.save /etc/sysconfig/iptables family=ipv6 ''' if _conf() and not filename: ...
Check for the existence of a rule in the table and chain
def check(table='filter', chain=None, rule=None, family='ipv4'): ''' Check for the existence of a rule in the table and chain This function accepts a rule in a standard iptables command format, starting with the chain. Trying to force users to adapt to a new method of creating rules would b...
.. versionadded:: 2014. 1. 0
def check_chain(table='filter', chain=None, family='ipv4'): ''' .. versionadded:: 2014.1.0 Check for the existence of a chain in the table CLI Example: .. code-block:: bash salt '*' iptables.check_chain filter INPUT IPv6: salt '*' iptables.check_chain filter INPUT family...
.. versionadded:: 2014. 1. 0
def new_chain(table='filter', chain=None, family='ipv4'): ''' .. versionadded:: 2014.1.0 Create new custom chain to the specified table. CLI Example: .. code-block:: bash salt '*' iptables.new_chain filter CUSTOM_CHAIN IPv6: salt '*' iptables.new_chain filter CUSTOM_CHAI...
Append a rule to the specified table/ chain.
def append(table='filter', chain=None, rule=None, family='ipv4'): ''' Append a rule to the specified table/chain. This function accepts a rule in a standard iptables command format, starting with the chain. Trying to force users to adapt to a new method of creating rules would be irritating...
Insert a rule into the specified table/ chain at the specified position.
def insert(table='filter', chain=None, position=None, rule=None, family='ipv4'): ''' Insert a rule into the specified table/chain, at the specified position. This function accepts a rule in a standard iptables command format, starting with the chain. Trying to force users to adapt to a new ...
Delete a rule from the specified table/ chain specifying either the rule in its entirety or the rule s position in the chain.
def delete(table, chain=None, position=None, rule=None, family='ipv4'): ''' Delete a rule from the specified table/chain, specifying either the rule in its entirety, or the rule's position in the chain. This function accepts a rule in a standard iptables command format, starting with the ch...
Flush the chain in the specified table flush all chains in the specified table if not specified chain.
def flush(table='filter', chain='', family='ipv4'): ''' Flush the chain in the specified table, flush all chains in the specified table if not specified chain. CLI Example: .. code-block:: bash salt '*' iptables.flush filter INPUT IPv6: salt '*' iptables.flush filter INPU...
If a file is not passed in and the correct one for this OS is not detected return False
def _parse_conf(conf_file=None, in_mem=False, family='ipv4'): ''' If a file is not passed in, and the correct one for this OS is not detected, return False ''' if _conf() and not conf_file and not in_mem: conf_file = _conf(family) rules = '' if conf_file: with salt.utils.fil...
This function attempts to list all the options documented in the iptables ( 8 ) and iptables - extensions ( 8 ) man pages. They will not all be used by all parts of the module ; use them intelligently and appropriately.
def _parser(): ''' This function attempts to list all the options documented in the iptables(8) and iptables-extensions(8) man pages. They will not all be used by all parts of the module; use them intelligently and appropriately. ''' add_arg = None if sys.version.startswith('2.6'): ...
Return a dict of the changes required for a group if the group is present otherwise return False.
def _changes(name, gid=None, addusers=None, delusers=None, members=None): ''' Return a dict of the changes required for a group if the group is present, otherwise return False. ''' lgrp = __salt__['group.info'](name) if not lgrp: return...
r Ensure that a group is present
def present(name, gid=None, system=False, addusers=None, delusers=None, members=None): r''' Ensure that a group is present Args: name (str): The name of the group to manage gid (str): The group id to assig...
Just a convenience function for __salt__ [ cmd. run_all ] ( cmd )
def _run(cmd): ''' Just a convenience function for ``__salt__['cmd.run_all'](cmd)`` ''' return __salt__['cmd.run_all'](cmd, env={'HOME': os.path.expanduser('~{0}'.format(__opts__['user']))})
nix - env with quiet option. By default nix is extremely verbose and prints the build log of every package to stderr. This tells nix to only show changes.
def _nix_env(): ''' nix-env with quiet option. By default, nix is extremely verbose and prints the build log of every package to stderr. This tells nix to only show changes. ''' nixhome = os.path.join(os.path.expanduser('~{0}'.format(__opts__['user'])), '.nix-profile/bin/') return [os.path.join(...
Make sure we get the right nix - store too.
def _nix_collect_garbage(): ''' Make sure we get the right nix-store, too. ''' nixhome = os.path.join(os.path.expanduser('~{0}'.format(__opts__['user'])), '.nix-profile/bin/') return [os.path.join(nixhome, 'nix-collect-garbage')]
intersperse x into ys with an extra element at the beginning.
def _zip_flatten(x, ys): ''' intersperse x into ys, with an extra element at the beginning. ''' return itertools.chain.from_iterable( zip(itertools.repeat(x), ys))
gets a list of all the packages that were affected by operation splits it up ( there can be multiple packages on a line ) and then flattens that list. We make it to a list for easier parsing.
def _output_format(out, operation): ''' gets a list of all the packages that were affected by ``operation``, splits it up (there can be multiple packages on a line), and then flattens that list. We make it to a list for easier parsing. ''' return [s.split()[1:] for s in out ...
Runs an update operation on the specified packages or all packages if none is specified.
def upgrade(*pkgs): ''' Runs an update operation on the specified packages, or all packages if none is specified. :type pkgs: list(str) :param pkgs: List of packages to update :return: The upgraded packages. Example element: ``['libxslt-1.1.0', 'libxslt-1.1.10']`` :rtype: list(tuple(st...
Installs a single or multiple packages via nix
def install(*pkgs, **kwargs): ''' Installs a single or multiple packages via nix :type pkgs: list(str) :param pkgs: packages to update :param bool attributes: Pass the list of packages or single package as attribues, not package names. default: False :return: Installed ...
Lists installed packages. Due to how nix works it defaults to just doing a nix - env - q.
def list_pkgs(installed=True, attributes=True): ''' Lists installed packages. Due to how nix works, it defaults to just doing a ``nix-env -q``. :param bool installed: list only installed packages. This can be a very long list (12,000+ elements), so caution is advised. Default:...
Erases a package from the current nix profile. Nix uninstalls work differently than other package managers and the symlinks in the profile are removed while the actual package remains. There is also a nix. purge function to clear the package cache of unused packages.
def uninstall(*pkgs): ''' Erases a package from the current nix profile. Nix uninstalls work differently than other package managers, and the symlinks in the profile are removed, while the actual package remains. There is also a ``nix.purge`` function, to clear the package cache of unused packages. ...
Completely removed all currently uninstalled packages in the nix store.
def collect_garbage(): ''' Completely removed all currently 'uninstalled' packages in the nix store. Tells the user how many store paths were removed and how much space was freed. :return: How much space was freed and how many derivations were removed :rtype: str .. warning:: This is a...
Collect minion external pillars from a RethinkDB database
def ext_pillar(minion_id, pillar, table='pillar', id_field=None, field=None, pillar_key=None): ''' Collect minion external pillars from a RethinkDB database Arguments: * `table`: The RethinkDB table containing external pillar in...
Same as original _proc_function in AsyncClientMixin except it calls low without firing a print event.
def _proc_function(self, fun, low, user, tag, jid, daemonize=True): ''' Same as original _proc_function in AsyncClientMixin, except it calls "low" without firing a print event. ''' if daemonize and not salt.utils.platform.is_windows(): salt.log.setup.shutdown_multipro...
Execute a puppet run and return a dict with the stderr stdout return code etc. The first positional argument given is checked as a subcommand. Following positional arguments should be ordered with arguments required by the subcommand first followed by non - keyword arguments. Tags are specified by a tag keyword and com...
def run(*args, **kwargs): ''' Execute a puppet run and return a dict with the stderr, stdout, return code, etc. The first positional argument given is checked as a subcommand. Following positional arguments should be ordered with arguments required by the subcommand first, followed by non-keyword ar...
.. versionadded:: 2014. 7. 0
def enable(): ''' .. versionadded:: 2014.7.0 Enable the puppet agent CLI Example: .. code-block:: bash salt '*' puppet.enable ''' puppet = _Puppet() if os.path.isfile(puppet.disabled_lockfile): try: os.remove(puppet.disabled_lockfile) except (IOEr...
.. versionadded:: 2014. 7. 0
def disable(message=None): ''' .. versionadded:: 2014.7.0 Disable the puppet agent message .. versionadded:: 2015.5.2 Disable message to send to puppet CLI Example: .. code-block:: bash salt '*' puppet.disable salt '*' puppet.disable 'Disabled, contact XYZ b...
.. versionadded:: 2014. 7. 0
def status(): ''' .. versionadded:: 2014.7.0 Display puppet agent status CLI Example: .. code-block:: bash salt '*' puppet.status ''' puppet = _Puppet() if os.path.isfile(puppet.disabled_lockfile): return 'Administratively disabled' if os.path.isfile(puppet.run_...
.. versionadded:: 2014. 7. 0
def summary(): ''' .. versionadded:: 2014.7.0 Show a summary of the last puppet agent run CLI Example: .. code-block:: bash salt '*' puppet.summary ''' puppet = _Puppet() try: with salt.utils.files.fopen(puppet.lastrunfile, 'r') as fp_: report = salt.uti...
Run facter and return the results
def facts(puppet=False): ''' Run facter and return the results CLI Example: .. code-block:: bash salt '*' puppet.facts ''' ret = {} opt_puppet = '--puppet' if puppet else '' cmd_ret = __salt__['cmd.run_all']('facter {0}'.format(opt_puppet)) if cmd_ret['retcode'] != 0: ...
Run facter for a specific fact
def fact(name, puppet=False): ''' Run facter for a specific fact CLI Example: .. code-block:: bash salt '*' puppet.fact kernel ''' opt_puppet = '--puppet' if puppet else '' ret = __salt__['cmd.run_all']( 'facter {0} {1}'.format(opt_puppet, name), python_she...
Read in arguments for the current subcommand. These are added to the cmd line without -- appended. Any others are redirected as standard options with the double hyphen prefixed.
def arguments(self, args=None): ''' Read in arguments for the current subcommand. These are added to the cmd line without '--' appended. Any others are redirected as standard options with the double hyphen prefixed. ''' # permits deleting elements rather than using slices...
.. versionadded:: 2015. 8. 0
def keys_present(name, number, save_dir, region=None, key=None, keyid=None, profile=None, save_format="{2}\n{0}\n{3}\n{1}\n"): ''' .. versionadded:: 2015.8.0 Ensure the IAM access keys are present. name (string) The name of the new user. number (int) Number of key...
Change account policy.
def account_policy(name=None, allow_users_to_change_password=None, hard_expiry=None, max_password_age=None, minimum_password_length=None, password_reuse_prevention=None, require_lowercase_characters=None, require_numbers=None, require_symbols=N...
Crete server certificate.
def server_cert_present(name, public_key, private_key, cert_chain=None, path=None, region=None, key=None, keyid=None, profile=None): ''' Crete server certificate. .. versionadded:: 2015.8.0 name (string) The name for the server certificate. Do not include the path in th...
.. versionadded:: 2016. 11. 0
def saml_provider_present(name, saml_metadata_document, region=None, key=None, keyid=None, profile=None): ''' .. versionadded:: 2016.11.0 Ensure the SAML provider with the specified name is present. name (string) The name of the SAML provider. saml_metadata_document (string) The x...
.. versionadded:: 2016. 11. 0
def saml_provider_absent(name, region=None, key=None, keyid=None, profile=None): ''' .. versionadded:: 2016.11.0 Ensure the SAML provider with the specified name is absent. name (string) The name of the SAML provider. saml_metadata_document (string) The xml document of the SAML pr...
Provides the BGP configuration on the device.
def config(group=None, neighbor=None, **kwargs): ''' Provides the BGP configuration on the device. :param group: Name of the group selected to display the configuration. :param neighbor: IP Address of the neighbor to display the configuration. If the group parameter is not specified, the neigh...
Execute a salt function on a specific minion
def _salt(fun, *args, **kw): '''Execute a salt function on a specific minion Special kwargs: salt_target target to exec things on salt_timeout timeout for jobs salt_job_poll poll interval to wait for job finish result ''' ...
Return a list of the VMs that are on the provider with select fields
def list_nodes_select(call=None): ''' Return a list of the VMs that are on the provider, with select fields ''' if not call: call = 'select' if not get_configured_provider(): return info = ['id', 'name', 'image', 'size', 'state', 'public_ips', 'private_ips'] return salt.utils...
Destroy a lxc container
def destroy(vm_, call=None): '''Destroy a lxc container''' destroy_opt = __opts__.get('destroy', False) profiles = __opts__.get('profiles', {}) profile = __opts__.get('profile', __opts__.get('internal_lxc_profile', [])) path = None if profile and profile in profiles: ...
Create an lxc Container. This function is idempotent and will try to either provision or finish the provision of an lxc container.
def create(vm_, call=None): '''Create an lxc Container. This function is idempotent and will try to either provision or finish the provision of an lxc container. NOTE: Most of the initialization code has been moved and merged with the lxc runner and lxc.init functions ''' prov = get_configu...
Return the contextual provider of None if no configured one can be found.
def get_configured_provider(vm_=None): ''' Return the contextual provider of None if no configured one can be found. ''' if vm_ is None: vm_ = {} dalias, driver = __active_provider_name__.split(':') data = None tgt = 'unknown' img_provider = __opts__.get('list_images', '') ...
Write a launchd plist for managing salt - master or salt - minion
def write_launchd_plist(program): ''' Write a launchd plist for managing salt-master or salt-minion CLI Example: .. code-block:: bash salt-run launchd.write_launchd_plist salt-master ''' plist_sample_text = ''' <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//D...
Return some CPU information on Windows minions
def _windows_cpudata(): ''' Return some CPU information on Windows minions ''' # Provides: # num_cpus # cpu_model grains = {} if 'NUMBER_OF_PROCESSORS' in os.environ: # Cast to int so that the logic isn't broken when used as a # conditional in templating. Also follows...
Return some CPU information for Linux minions
def _linux_cpudata(): ''' Return some CPU information for Linux minions ''' # Provides: # num_cpus # cpu_model # cpu_flags grains = {} cpuinfo = '/proc/cpuinfo' # Parse over the cpuinfo file if os.path.isfile(cpuinfo): with salt.utils.files.fopen(cpuinfo, 'r') a...
num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string
def _linux_gpu_data(): ''' num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string ''' if __opts__.get('enable_lspci', True) is False: return {} if __opts__.get('enable_gpu_grains', True) is False: return {} lspci = salt.utils.path.which('lspci') if...
num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string
def _netbsd_gpu_data(): ''' num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string ''' known_vendors = ['nvidia', 'amd', 'ati', 'intel', 'cirrus logic', 'vmware', 'matrox', 'aspeed'] gpus = [] try: pcictl_out = __salt__['cmd.run']('pcictl pci0 list') f...
num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string
def _osx_gpudata(): ''' num_gpus: int gpus: - vendor: nvidia|amd|ati|... model: string ''' gpus = [] try: pcictl_out = __salt__['cmd.run']('system_profiler SPDisplaysDataType') for line in pcictl_out.splitlines(): fieldname, _, fieldval = line.partitio...
Return CPU information for BSD - like systems
def _bsd_cpudata(osdata): ''' Return CPU information for BSD-like systems ''' # Provides: # cpuarch # num_cpus # cpu_model # cpu_flags sysctl = salt.utils.path.which('sysctl') arch = salt.utils.path.which('arch') cmds = {} if sysctl: cmds.update({ ...
Return the CPU information for Solaris - like systems
def _sunos_cpudata(): ''' Return the CPU information for Solaris-like systems ''' # Provides: # cpuarch # num_cpus # cpu_model # cpu_flags grains = {} grains['cpu_flags'] = [] grains['cpuarch'] = __salt__['cmd.run']('isainfo -k') psrinfo = '/usr/sbin/psrinfo 2>/d...
Return CPU information for AIX systems
def _aix_cpudata(): ''' Return CPU information for AIX systems ''' # Provides: # cpuarch # num_cpus # cpu_model # cpu_flags grains = {} cmd = salt.utils.path.which('prtconf') if cmd: data = __salt__['cmd.run']('{0}'.format(cmd)) + os.linesep for dest, ...
Return the memory information for Linux - like systems
def _linux_memdata(): ''' Return the memory information for Linux-like systems ''' grains = {'mem_total': 0, 'swap_total': 0} meminfo = '/proc/meminfo' if os.path.isfile(meminfo): with salt.utils.files.fopen(meminfo, 'r') as ifile: for line in ifile: comps = ...
Return the memory information for BSD - like systems
def _osx_memdata(): ''' Return the memory information for BSD-like systems ''' grains = {'mem_total': 0, 'swap_total': 0} sysctl = salt.utils.path.which('sysctl') if sysctl: mem = __salt__['cmd.run']('{0} -n hw.memsize'.format(sysctl)) swap_total = __salt__['cmd.run']('{0} -n vm...
Return the memory information for BSD - like systems
def _bsd_memdata(osdata): ''' Return the memory information for BSD-like systems ''' grains = {'mem_total': 0, 'swap_total': 0} sysctl = salt.utils.path.which('sysctl') if sysctl: mem = __salt__['cmd.run']('{0} -n hw.physmem'.format(sysctl)) if osdata['kernel'] == 'NetBSD' and m...
Return the memory information for SunOS - like systems
def _sunos_memdata(): ''' Return the memory information for SunOS-like systems ''' grains = {'mem_total': 0, 'swap_total': 0} prtconf = '/usr/sbin/prtconf 2>/dev/null' for line in __salt__['cmd.run'](prtconf, python_shell=True).splitlines(): comps = line.split(' ') if comps[0].s...
Return the memory information for AIX systems
def _aix_memdata(): ''' Return the memory information for AIX systems ''' grains = {'mem_total': 0, 'swap_total': 0} prtconf = salt.utils.path.which('prtconf') if prtconf: for line in __salt__['cmd.run'](prtconf, python_shell=True).splitlines(): comps = [x for x in line.strip...
Gather information about the system memory
def _memdata(osdata): ''' Gather information about the system memory ''' # Provides: # mem_total # swap_total, for supported systems. grains = {'mem_total': 0} if osdata['kernel'] == 'Linux': grains.update(_linux_memdata()) elif osdata['kernel'] in ('FreeBSD', 'OpenBSD', ...
Parse the output of lsattr - El sys0 for os_uuid
def _aix_get_machine_id(): ''' Parse the output of lsattr -El sys0 for os_uuid ''' grains = {} cmd = salt.utils.path.which('lsattr') if cmd: data = __salt__['cmd.run']('{0} -El sys0'.format(cmd)) + os.linesep uuid_regexes = [re.compile(r'(?im)^\s*os_uuid\s+(\S+)\s+(.*)')] ...
Returns what type of virtual hardware is under the hood kvm or physical
def _windows_virtual(osdata): ''' Returns what type of virtual hardware is under the hood, kvm or physical ''' # Provides: # virtual # virtual_subtype grains = dict() if osdata['kernel'] != 'Windows': return grains grains['virtual'] = 'physical' # It is possible tha...
Returns what type of virtual hardware is under the hood kvm or physical
def _virtual(osdata): ''' Returns what type of virtual hardware is under the hood, kvm or physical ''' # This is going to be a monster, if you are running a vm you can test this # grain with please submit patches! # Provides: # virtual # virtual_subtype grains = {'virtual': 'phys...
Returns detailed hypervisor information from sysfs Currently this seems to be used only by Xen
def _virtual_hv(osdata): ''' Returns detailed hypervisor information from sysfs Currently this seems to be used only by Xen ''' grains = {} # Bail early if we're not running on Xen try: if 'xen' not in osdata['virtual']: return grains except KeyError: return ...
Return the ps grain
def _ps(osdata): ''' Return the ps grain ''' grains = {} bsd_choices = ('FreeBSD', 'NetBSD', 'OpenBSD', 'MacOS') if osdata['os'] in bsd_choices: grains['ps'] = 'ps auxwww' elif osdata['os_family'] == 'Solaris': grains['ps'] = '/usr/ucb/ps auxwww' elif osdata['os'] == 'Win...
Clean out well - known bogus values. If it isn t clean ( for example has value None ) return None. Otherwise return the original value.
def _clean_value(key, val): ''' Clean out well-known bogus values. If it isn't clean (for example has value 'None'), return None. Otherwise, return the original value. NOTE: This logic also exists in the smbios module. This function is for use when not using smbios to retrieve the value. ...
Use the platform module for as much as we can.
def _windows_platform_data(): ''' Use the platform module for as much as we can. ''' # Provides: # kernelrelease # kernelversion # osversion # osrelease # osservicepack # osmanufacturer # manufacturer # productname # biosversion # ser...
Additional data for macOS systems Returns: A dictionary containing values for the following: - model_name - boot_rom_version - smc_version - system_serialnumber
def _osx_platform_data(): ''' Additional data for macOS systems Returns: A dictionary containing values for the following: - model_name - boot_rom_version - smc_version - system_serialnumber ''' cmd = 'system_profiler SPHardwareDataType' hardware = __salt__['cmd.r...
Does a binary exist in linux ( depends on which type or whereis )
def _linux_bin_exists(binary): ''' Does a binary exist in linux (depends on which, type, or whereis) ''' for search_cmd in ('which', 'type -ap'): try: return __salt__['cmd.retcode']( '{0} {1}'.format(search_cmd, binary) ) == 0 except salt.exception...
Parse os - release and return a parameter dictionary
def _parse_os_release(*os_release_files): ''' Parse os-release and return a parameter dictionary See http://www.freedesktop.org/software/systemd/man/os-release.html for specification of the file format. ''' ret = {} for filename in os_release_files: try: with salt.utils....
Parse CPE_NAME data from the os - release
def _parse_cpe_name(cpe): ''' Parse CPE_NAME data from the os-release Info: https://csrc.nist.gov/projects/security-content-automation-protocol/scap-specifications/cpe :param cpe: :return: ''' part = { 'o': 'operating system', 'h': 'hardware', 'a': 'application', ...
Return grains pertaining to the operating system
def os_data(): ''' Return grains pertaining to the operating system ''' grains = { 'num_gpus': 0, 'gpus': [], } # Windows Server 2008 64-bit # ('Windows', 'MINIONNAME', '2008ServerR2', '6.1.7601', 'AMD64', # 'Intel64 Fam ily 6 Model 23 Stepping 6, GenuineIntel') ...
Provides defaultlanguage defaultencoding
def locale_info(): ''' Provides defaultlanguage defaultencoding ''' grains = {} grains['locale_info'] = {} if salt.utils.platform.is_proxy(): return grains try: ( grains['locale_info']['defaultlanguage'], grains['locale_info']['defaul...
Return fqdn hostname domainname
def hostname(): ''' Return fqdn, hostname, domainname ''' # This is going to need some work # Provides: # fqdn # host # localhost # domain global __FQDN__ grains = {} if salt.utils.platform.is_proxy(): return grains grains['localhost'] = socket.getho...
Return append_domain if set
def append_domain(): ''' Return append_domain if set ''' grain = {} if salt.utils.platform.is_proxy(): return grain if 'append_domain' in __opts__: grain['append_domain'] = __opts__['append_domain'] return grain
Return all known FQDNs for the system by enumerating all interfaces and then trying to reverse resolve them ( excluding lo interface ).
def fqdns(): ''' Return all known FQDNs for the system by enumerating all interfaces and then trying to reverse resolve them (excluding 'lo' interface). ''' # Provides: # fqdns grains = {} fqdns = set() addresses = salt.utils.network.ip_addrs(include_loopback=False, interface_data=...
Return ip address and FQDN grains
def ip_fqdn(): ''' Return ip address and FQDN grains ''' if salt.utils.platform.is_proxy(): return {} ret = {} ret['ipv4'] = salt.utils.network.ip_addrs(include_loopback=True) ret['ipv6'] = salt.utils.network.ip_addrs6(include_loopback=True) _fqdn = hostname()['fqdn'] for s...
Provide a dict of the connected interfaces and their ip addresses The addresses will be passed as a list for each interface
def ip_interfaces(): ''' Provide a dict of the connected interfaces and their ip addresses The addresses will be passed as a list for each interface ''' # Provides: # ip_interfaces if salt.utils.platform.is_proxy(): return {} ret = {} ifaces = _get_interfaces() for fa...
Provide a dict of the connected interfaces and their hw addresses ( Mac Address )
def hwaddr_interfaces(): ''' Provide a dict of the connected interfaces and their hw addresses (Mac Address) ''' # Provides: # hwaddr_interfaces ret = {} ifaces = _get_interfaces() for face in ifaces: if 'hwaddr' in ifaces[face]: ret[face] = ifaces[face]['hwaddr...
Parse the resolver configuration file
def dns(): ''' Parse the resolver configuration file .. versionadded:: 2016.3.0 ''' # Provides: # dns if salt.utils.platform.is_windows() or 'proxyminion' in __opts__: return {} resolv = salt.utils.dns.parse_resolv() for key in ('nameservers', 'ip4_nameservers', 'ip6_nam...
Provide the machine - id for machine/ virtualization combination
def get_machine_id(): ''' Provide the machine-id for machine/virtualization combination ''' # Provides: # machine-id if platform.system() == 'AIX': return _aix_get_machine_id() locations = ['/etc/machine-id', '/var/lib/dbus/machine-id'] existing_locations = [loc for loc in loc...
Return the path of the salt module
def saltpath(): ''' Return the path of the salt module ''' # Provides: # saltpath salt_path = os.path.abspath(os.path.join(__file__, os.path.pardir)) return {'saltpath': os.path.dirname(salt_path)}
Get system specific hardware data from dmidecode
def _hw_data(osdata): ''' Get system specific hardware data from dmidecode Provides biosversion productname manufacturer serialnumber biosreleasedate uuid .. versionadded:: 0.9.5 ''' if salt.utils.platform.is_proxy(): return {} grai...
Shell - out Python 3 for compute reliable hash: return:
def _get_hash_by_shell(): ''' Shell-out Python 3 for compute reliable hash :return: ''' id_ = __opts__.get('id', '') id_hash = None py_ver = sys.version_info[:2] if py_ver >= (3, 3): # Python 3.3 enabled hash randomization, so we need to shell out to get # a reliable hash...
Provides an integer based on the FQDN of a machine. Useful as server - id in MySQL replication or anywhere else you ll need an ID like this.
def get_server_id(): ''' Provides an integer based on the FQDN of a machine. Useful as server-id in MySQL replication or anywhere else you'll need an ID like this. ''' # Provides: # server_id if salt.utils.platform.is_proxy(): server_id = {} else: use_crc = __opts_...
Populates grains which describe whether a server has a default gateway configured or not. Uses ip - 4 route show and ip - 6 route show and greps for a default at the beginning of any line. Assuming the standard default via <ip > format for default gateways it will also parse out the ip address of the default gateway an...
def default_gateway(): ''' Populates grains which describe whether a server has a default gateway configured or not. Uses `ip -4 route show` and `ip -6 route show` and greps for a `default` at the beginning of any line. Assuming the standard `default via <ip>` format for default gateways, it will al...
Return the kernel boot parameters
def kernelparams(): ''' Return the kernel boot parameters ''' if salt.utils.platform.is_windows(): # TODO: add grains using `bcdedit /enum {current}` return {} else: try: with salt.utils.files.fopen('/proc/cmdline', 'r') as fhr: cmdline = fhr.read(...
Helper function to find valid table attributes
def _table_attrs(table): ''' Helper function to find valid table attributes ''' cmd = ['osqueryi'] + ['--json'] + ['pragma table_info({0})'.format(table)] res = __salt__['cmd.run_all'](cmd) if res['retcode'] == 0: attrs = [] text = salt.utils.json.loads(res['stdout']) for...
Helper function to run raw osquery queries
def _osquery(sql, format='json'): ''' Helper function to run raw osquery queries ''' ret = { 'result': True, } cmd = ['osqueryi'] + ['--json'] + [sql] res = __salt__['cmd.run_all'](cmd) if res['stderr']: ret['result'] = False ret['error'] = res['stderr'] else...
Helper function to run osquery queries
def _osquery_cmd(table, attrs=None, where=None, format='json'): ''' Helper function to run osquery queries ''' ret = { 'result': True, } if attrs: if isinstance(attrs, list): valid_attrs = _table_attrs(table) if valid_attrs: for a in attrs...
Return version of osquery
def version(): ''' Return version of osquery CLI Example: .. code-block:: bash salt '*' osquery.version ''' _false_return = {'result': False, 'comment': 'OSQuery version unavailable.'} res = _osquery_cmd(table='osquery_info', attrs=['version']) if 'result'...
Return cpuid information from osquery
def rpm_packages(attrs=None, where=None): ''' Return cpuid information from osquery CLI Example: .. code-block:: bash salt '*' osquery.rpm_packages ''' if __grains__['os_family'] == 'RedHat': return _osquery_cmd(table='rpm_packages', attrs=attrs, where=where) return {'resu...
Return kernel_integrity information from osquery
def kernel_integrity(attrs=None, where=None): ''' Return kernel_integrity information from osquery CLI Example: .. code-block:: bash salt '*' osquery.kernel_integrity ''' if __grains__['os_family'] in ['RedHat', 'Debian']: return _osquery_cmd(table='kernel_integrity', attrs=at...
Return kernel_modules information from osquery
def kernel_modules(attrs=None, where=None): ''' Return kernel_modules information from osquery CLI Example: .. code-block:: bash salt '*' osquery.kernel_modules ''' if __grains__['os_family'] in ['RedHat', 'Debian']: return _osquery_cmd(table='kernel_modules', attrs=attrs, whe...
Return memory_map information from osquery
def memory_map(attrs=None, where=None): ''' Return memory_map information from osquery CLI Example: .. code-block:: bash salt '*' osquery.memory_map ''' if __grains__['os_family'] in ['RedHat', 'Debian']: return _osquery_cmd(table='memory_map', attrs=attrs, where=where) re...
Return process_memory_map information from osquery
def process_memory_map(attrs=None, where=None): ''' Return process_memory_map information from osquery CLI Example: .. code-block:: bash salt '*' osquery.process_memory_map ''' if __grains__['os_family'] in ['RedHat', 'Debian']: return _osquery_cmd(table='process_memory_map', ...
Return shared_memory information from osquery
def shared_memory(attrs=None, where=None): ''' Return shared_memory information from osquery CLI Example: .. code-block:: bash salt '*' osquery.shared_memory ''' if __grains__['os_family'] in ['RedHat', 'Debian']: return _osquery_cmd(table='shared_memory', attrs=attrs, where=w...
Return apt_sources information from osquery
def apt_sources(attrs=None, where=None): ''' Return apt_sources information from osquery CLI Example: .. code-block:: bash salt '*' osquery.apt_sources ''' if __grains__['os_family'] == 'Debian': return _osquery_cmd(table='apt_sources', attrs=attrs, where=where) return {'r...
Return deb_packages information from osquery
def deb_packages(attrs=None, where=None): ''' Return deb_packages information from osquery CLI Example: .. code-block:: bash salt '*' osquery.deb_packages ''' if __grains__['os_family'] == 'Debian': return _osquery_cmd(table='deb_packages', attrs=attrs, where=where) return...
Return alf information from osquery
def alf(attrs=None, where=None): ''' Return alf information from osquery CLI Example: .. code-block:: bash salt '*' osquery.alf ''' if salt.utils.platform.is_darwin(): return _osquery_cmd(table='alf', attrs=attrs, where=where) return {'result': False, 'comment': 'Only avai...