• Overview
  • Salt User Guide
  • Documentation
  • Downloads
  • Develop
Edit on GitHub
  • Table of Contents
  • Glossary
  • previous
  • next
  • all salt modules
  • routing table
  • index

salt.modules.splunk_search¶

Module for interop with the Splunk API

New in version 2015.5.0.

depends:
  • splunk-sdk python module

configuration:

Configure this module by specifying the name of a configuration profile in the minion config, minion pillar, or master config. The module will use the 'splunk' key by default, if defined.

For example:

splunk:
    username: alice
    password: abc123
    host: example.splunkcloud.com
    port: 8080
salt.modules.splunk_search.create(name, profile='splunk', **kwargs)¶

Create a splunk search

CLI Example:

splunk_search.create 'my search name' search='error msg'

salt.modules.splunk_search.delete(name, profile='splunk')¶

Delete a splunk search

CLI Example:

splunk_search.delete 'my search name'

salt.modules.splunk_search.get(name, profile='splunk')¶

Get a splunk search

CLI Example:

splunk_search.get 'my search name'

salt.modules.splunk_search.list_(profile='splunk')¶

List splunk searches (names only)

CLI Example:

splunk_search.list

salt.modules.splunk_search.list_all(prefix=None, app=None, owner=None, description_contains=None, name_not_contains=None, profile='splunk')¶

Get all splunk search details. Produces results that can be used to create an sls file.

if app or owner are specified, results will be limited to matching saved searches.

if description_contains is specified, results will be limited to those where "description_contains in description" is true if name_not_contains is specified, results will be limited to those where "name_not_contains not in name" is true.

If prefix parameter is given, alarm names in the output will be prepended with the prefix; alarms that have the prefix will be skipped. This can be used to convert existing alarms to be managed by salt, as follows:

CLI Example:

  1. Make a "backup" of all existing searches

    $ salt-call splunk_search.list_all --out=txt | sed "s/local: //" > legacy_searches.sls

  2. Get all searches with new prefixed names

    $ salt-call splunk_search.list_all "prefix=**MANAGED BY SALT** " --out=txt | sed "s/local: //" > managed_searches.sls

  3. Insert the managed searches into splunk

    $ salt-call state.sls managed_searches.sls

  4. Manually verify that the new searches look right

  5. Delete the original searches $ sed s/present/absent/ legacy_searches.sls > remove_legacy_searches.sls $ salt-call state.sls remove_legacy_searches.sls

  6. Get all searches again, verify no changes $ salt-call splunk_search.list_all --out=txt | sed "s/local: //" > final_searches.sls $ diff final_searches.sls managed_searches.sls

salt.modules.splunk_search.update(name, profile='splunk', **kwargs)¶

Update a splunk search

CLI Example:

splunk_search.update 'my search name' sharing=app


Generated on May 03, 2025 at 01:45:22 UTC.

You are viewing docs for the previous stable release, 3006.10. Switch to docs for the latest stable release, 3007.1, or to a recent doc build from the master branch.


saltproject.io

© 2025 VMware, Inc. | Privacy Policy

3006.10 3007.1 Master
  • Salt Project
  • Introduction to Salt
  • Salt system architecture
  • Contributing to Salt: A Guide for Contributors
  • Salt Project maintenance policies
  • Installation
  • Configuring Salt
  • Using Salt
  • Remote Execution
  • Configuration Management
  • Return Codes
  • Utility Modules - Code Reuse in Custom Modules
  • Events & Reactor
  • Orchestration
  • Solaris
  • Salt SSH
  • Thorium Complex Reactor
  • Salt Cloud
  • Salt Proxy Minion
  • Network Automation
  • Salt Virt
  • Onedir Packaging
  • Command Line Reference
  • Pillars
  • Master Tops
  • Salt Module Reference
    • auth modules
    • beacon modules
    • cache modules
    • cloud modules
    • Configuring Salt
    • engine modules
    • execution modules
      • salt.modules.group
      • salt.modules.kernelpkg
      • salt.modules.pkg
      • salt.modules.service
      • salt.modules.shadow
      • salt.modules.sysctl
      • salt.modules.user
      • salt.modules.acme
      • salt.modules.aix_group
      • salt.modules.aix_shadow
      • salt.modules.aixpkg
      • salt.modules.aliases
      • salt.modules.alternatives
      • salt.modules.ansiblegate
      • salt.modules.apache
      • salt.modules.apcups
      • salt.modules.apf
      • salt.modules.apkpkg
      • salt.modules.aptly
      • salt.modules.aptpkg
      • salt.modules.archive
      • salt.modules.arista_pyeapi
      • salt.modules.artifactory
      • salt.modules.at
      • salt.modules.at_solaris
      • salt.modules.augeas_cfg
      • salt.modules.aws_sqs
      • salt.modules.azurearm_compute
      • salt.modules.azurearm_dns
      • salt.modules.azurearm_network
      • salt.modules.azurearm_resource
      • salt.modules.bamboohr
      • salt.modules.baredoc
      • salt.modules.bcache
      • salt.modules.beacons
      • salt.modules.bigip
      • salt.modules.bluez_bluetooth
      • salt.modules.boto3_elasticache
      • salt.modules.boto3_elasticsearch
      • salt.modules.boto3_route53
      • salt.modules.boto3_sns
      • salt.modules.boto_apigateway
      • salt.modules.boto_asg
      • salt.modules.boto_cfn
      • salt.modules.boto_cloudfront
      • salt.modules.boto_cloudtrail
      • salt.modules.boto_cloudwatch
      • salt.modules.boto_cloudwatch_event
      • salt.modules.boto_cognitoidentity
      • salt.modules.boto_datapipeline
      • salt.modules.boto_dynamodb
      • salt.modules.boto_ec2
      • salt.modules.boto_efs
      • salt.modules.boto_elasticache
      • salt.modules.boto_elasticsearch_domain
      • salt.modules.boto_elb
      • salt.modules.boto_elbv2
      • salt.modules.boto_iam
      • salt.modules.boto_iot
      • salt.modules.boto_kinesis
      • salt.modules.boto_kms
      • salt.modules.boto_lambda
      • salt.modules.boto_rds
      • salt.modules.boto_route53
      • salt.modules.boto_s3
      • salt.modules.boto_s3_bucket
      • salt.modules.boto_secgroup
      • salt.modules.boto_sns
      • salt.modules.boto_sqs
      • salt.modules.boto_ssm
      • salt.modules.boto_vpc
      • salt.modules.bower
      • salt.modules.bridge
      • salt.modules.bsd_shadow
      • salt.modules.btrfs
      • salt.modules.cabal
      • salt.modules.capirca_acl
      • salt.modules.cassandra_cql
      • salt.modules.celery
      • salt.modules.ceph
      • salt.modules.chassis
      • salt.modules.chef
      • salt.modules.chocolatey
      • salt.modules.chronos
      • salt.modules.chroot
      • salt.modules.cimc
      • salt.modules.ciscoconfparse_mod
      • salt.modules.cisconso
      • salt.modules.cloud
      • salt.modules.cmdmod
      • salt.modules.composer
      • salt.modules.config
      • salt.modules.consul
      • salt.modules.container_resource
      • salt.modules.cp
      • salt.modules.cpan
      • salt.modules.cron
      • salt.modules.cryptdev
      • salt.modules.csf
      • salt.modules.cyg
      • salt.modules.daemontools
      • salt.modules.data
      • salt.modules.datadog_api
      • salt.modules.ddns
      • salt.modules.deb_apache
      • salt.modules.deb_postgres
      • salt.modules.debconfmod
      • salt.modules.debian_ip
      • salt.modules.debian_service
      • salt.modules.debuild_pkgbuild
      • salt.modules.defaults
      • salt.modules.devinfo
      • salt.modules.devmap
      • salt.modules.dig
      • salt.modules.disk
      • salt.modules.djangomod
      • salt.modules.dnsmasq
      • salt.modules.dnsutil
      • salt.modules.dockercompose
      • salt.modules.dockermod
      • salt.modules.dpkg_lowpkg
      • salt.modules.drac
      • salt.modules.dracr
      • salt.modules.drbd
      • salt.modules.dummyproxy_pkg
      • salt.modules.dummyproxy_service
      • salt.modules.ebuildpkg
      • salt.modules.eix
      • salt.modules.elasticsearch
      • salt.modules.environ
      • salt.modules.eselect
      • salt.modules.esxcluster
      • salt.modules.esxdatacenter
      • salt.modules.esxi
      • salt.modules.esxvm
      • salt.modules.etcd_mod
      • salt.modules.ethtool
      • salt.modules.event
      • salt.modules.extfs
      • salt.modules.file
      • salt.modules.firewalld
      • salt.modules.freebsd_sysctl
      • salt.modules.freebsd_update
      • salt.modules.freebsdjail
      • salt.modules.freebsdkmod
      • salt.modules.freebsdpkg
      • salt.modules.freebsdports
      • salt.modules.freebsdservice
      • salt.modules.freezer
      • salt.modules.gcp_addon
      • salt.modules.gem
      • salt.modules.genesis
      • salt.modules.gentoo_service
      • salt.modules.gentoolkitmod
      • salt.modules.git
      • salt.modules.github
      • salt.modules.glanceng
      • salt.modules.glassfish
      • salt.modules.glusterfs
      • salt.modules.gnomedesktop
      • salt.modules.google_chat
      • salt.modules.gpg
      • salt.modules.grafana4
      • salt.modules.grains
      • salt.modules.groupadd
      • salt.modules.grub_legacy
      • salt.modules.guestfs
      • salt.modules.hadoop
      • salt.modules.haproxyconn
      • salt.modules.hashutil
      • salt.modules.heat
      • salt.modules.helm
      • salt.modules.hg
      • salt.modules.highstate_doc
      • salt.modules.hosts
      • salt.modules.http
      • salt.modules.icinga2
      • salt.modules.idem
      • salt.modules.ifttt
      • salt.modules.ilo
      • salt.modules.incron
      • salt.modules.influxdb08mod
      • salt.modules.influxdbmod
      • salt.modules.infoblox
      • salt.modules.ini_manage
      • salt.modules.inspectlib package
      • salt.modules.inspectlib.collector
      • salt.modules.inspectlib.dbhandle
      • salt.modules.inspectlib.entities
      • salt.modules.inspectlib.exceptions
      • salt.modules.inspectlib.fsdb
      • salt.modules.inspectlib.kiwiproc
      • salt.modules.inspectlib.query
      • salt.modules.inspector
      • salt.modules.introspect
      • salt.modules.iosconfig
      • salt.modules.ipmi
      • salt.modules.ipset
      • salt.modules.iptables
      • salt.modules.iwtools
      • salt.modules.jboss7
      • salt.modules.jboss7_cli
      • salt.modules.jenkinsmod
      • salt.modules.jinja
      • salt.modules.jira_mod
      • salt.modules.junos
      • salt.modules.k8s
      • salt.modules.kapacitor
      • salt.modules.kerberos
      • salt.modules.kernelpkg_linux_apt
      • salt.modules.kernelpkg_linux_yum
      • salt.modules.key
      • salt.modules.keyboard
      • salt.modules.keystone
      • salt.modules.keystoneng
      • salt.modules.keystore
      • salt.modules.kmod
      • salt.modules.kubeadm
      • salt.modules.kubernetesmod
      • salt.modules.launchctl_service
      • salt.modules.layman
      • salt.modules.ldap3
      • salt.modules.ldapmod
      • salt.modules.libcloud_compute
      • salt.modules.libcloud_dns
      • salt.modules.libcloud_loadbalancer
      • salt.modules.libcloud_storage
      • salt.modules.linux_acl
      • salt.modules.linux_ip
      • salt.modules.linux_lvm
      • salt.modules.linux_service
      • salt.modules.linux_shadow
      • salt.modules.linux_sysctl
      • salt.modules.localemod
      • salt.modules.locate
      • salt.modules.logadm
      • salt.modules.logmod
      • salt.modules.logrotate
      • salt.modules.lvs
      • salt.modules.lxc
      • salt.modules.lxd
      • salt.modules.mac_assistive
      • salt.modules.mac_brew_pkg
      • salt.modules.mac_desktop
      • salt.modules.mac_group
      • salt.modules.mac_keychain
      • salt.modules.mac_pkgutil
      • salt.modules.mac_portspkg
      • salt.modules.mac_power
      • salt.modules.mac_service
      • salt.modules.mac_shadow
      • salt.modules.mac_softwareupdate
      • salt.modules.mac_sysctl
      • salt.modules.mac_system
      • salt.modules.mac_timezone
      • salt.modules.mac_user
      • salt.modules.mac_xattr
      • salt.modules.macdefaults
      • salt.modules.macpackage
      • salt.modules.makeconf
      • salt.modules.mandrill
      • salt.modules.marathon
      • salt.modules.match
      • salt.modules.mattermost
      • salt.modules.mdadm_raid
      • salt.modules.mdata
      • salt.modules.memcached
      • salt.modules.mine
      • salt.modules.minion
      • salt.modules.mod_random
      • salt.modules.modjk
      • salt.modules.mongodb
      • salt.modules.monit
      • salt.modules.moosefs
      • salt.modules.mount
      • salt.modules.mssql
      • salt.modules.msteams
      • salt.modules.munin
      • salt.modules.mysql
      • salt.modules.nacl
      • salt.modules.nagios
      • salt.modules.nagios_rpc
      • salt.modules.namecheap_domains
      • salt.modules.namecheap_domains_dns
      • salt.modules.namecheap_domains_ns
      • salt.modules.namecheap_ssl
      • salt.modules.namecheap_users
      • salt.modules.napalm_bgp
      • salt.modules.napalm_formula
      • salt.modules.napalm_mod
      • salt.modules.napalm_netacl
      • salt.modules.napalm_network
      • salt.modules.napalm_ntp
      • salt.modules.napalm_probes
      • salt.modules.napalm_route
      • salt.modules.napalm_snmp
      • salt.modules.napalm_users
      • salt.modules.napalm_yang_mod
      • salt.modules.netaddress
      • salt.modules.netbox
      • salt.modules.netbsd_sysctl
      • salt.modules.netbsdservice
      • salt.modules.netmiko_mod
      • salt.modules.netscaler
      • salt.modules.network
      • salt.modules.neutron
      • salt.modules.neutronng
      • salt.modules.nexus
      • salt.modules.nfs3
      • salt.modules.nftables
      • salt.modules.nginx
      • salt.modules.nilrt_ip
      • salt.modules.nix
      • salt.modules.nova
      • salt.modules.npm
      • salt.modules.nspawn
      • salt.modules.nxos
      • salt.modules.nxos_api
      • salt.modules.nxos_upgrade
      • salt.modules.omapi
      • salt.modules.openbsd_sysctl
      • salt.modules.openbsdpkg
      • salt.modules.openbsdrcctl_service.py
      • salt.modules.openbsdservice
      • salt.modules.openscap
      • salt.modules.openstack_config
      • salt.modules.openstack_mng
      • salt.modules.openvswitch
      • salt.modules.opkg
      • salt.modules.opsgenie
      • salt.modules.oracle
      • salt.modules.osquery
      • salt.modules.out
      • salt.modules.pacmanpkg
      • salt.modules.pagerduty
      • salt.modules.pagerduty_util
      • salt.modules.pam
      • salt.modules.panos
      • salt.modules.parallels
      • salt.modules.parted_partition
      • salt.modules.pcs
      • salt.modules.pdbedit
      • salt.modules.pecl
      • salt.modules.peeringdb
      • salt.modules.pf
      • salt.modules.philips_hue
      • salt.modules.pillar
      • salt.modules.pip
      • salt.modules.pkg_resource
      • salt.modules.pkgin
      • salt.modules.pkgng
      • salt.modules.pkgutil
      • salt.modules.portage_config
      • salt.modules.postfix
      • salt.modules.postgres
      • salt.modules.poudriere
      • salt.modules.powerpath
      • salt.modules.proxy
      • salt.modules.ps
      • salt.modules.publish
      • salt.modules.puppet
      • salt.modules.purefa
      • salt.modules.purefb
      • salt.modules.pushbullet
      • salt.modules.pushover_notify
      • salt.modules.pw_group
      • salt.modules.pw_user
      • salt.modules.pyenv
      • salt.modules.qemu_img
      • salt.modules.qemu_nbd
      • salt.modules.quota
      • salt.modules.rabbitmq
      • salt.modules.rallydev
      • salt.modules.random_org
      • salt.modules.rbac_solaris
      • salt.modules.rbenv
      • salt.modules.rdp
      • salt.modules.rebootmgr module
      • salt.modules.redis
      • salt.modules.reg
      • salt.modules.rest_pkg
      • salt.modules.rest_sample_utils
      • salt.modules.rest_service
      • salt.modules.restartcheck
      • salt.modules.restconf
      • salt.modules.ret
      • salt.modules.rh_ip
      • salt.modules.rh_service
      • salt.modules.riak
      • salt.modules.rpm_lowpkg
      • salt.modules.rpmbuild_pkgbuild
      • salt.modules.rsync
      • salt.modules.runit
      • salt.modules.rvm
      • salt.modules.s3
      • salt.modules.s6
      • salt.modules.salt_proxy
      • salt.modules.salt_version
      • salt.modules.saltcheck
      • salt.modules.saltcloudmod
      • salt.modules.saltutil
      • salt.modules.schedule
      • salt.modules.scp
      • salt.modules.scsi
      • salt.modules.sdb
      • salt.modules.seed
      • salt.modules.selinux
      • salt.modules.sensehat
      • salt.modules.sensors
      • salt.modules.serverdensity_device
      • salt.modules.servicenow
      • salt.modules.slack_notify
      • salt.modules.slackware_service
      • salt.modules.slsutil
      • salt.modules.smartos_imgadm
      • salt.modules.smartos_nictagadm
      • salt.modules.smartos_virt
      • salt.modules.smartos_vmadm
      • salt.modules.smbios
      • salt.modules.smf_service
      • salt.modules.smtp
      • salt.modules.snapper
      • salt.modules.solaris_fmadm
      • salt.modules.solaris_group
      • salt.modules.solaris_shadow
      • salt.modules.solaris_system
      • salt.modules.solaris_user
      • salt.modules.solarisipspkg
      • salt.modules.solarispkg
      • salt.modules.solr
      • salt.modules.solrcloud
      • salt.modules.splunk
      • salt.modules.splunk_search
        • create()
        • delete()
        • get()
        • list_()
        • list_all()
        • update()
      • salt.modules.sqlite3
      • salt.modules.ssh
      • salt.modules.ssh_pkg
      • salt.modules.ssh_service
      • salt.modules.state
      • salt.modules.status
      • salt.modules.statuspage
      • salt.modules.supervisord
      • salt.modules.suse_apache
      • salt.modules.suse_ip
      • salt.modules.svn
      • salt.modules.swarm
      • salt.modules.swift
      • salt.modules.sysbench
      • salt.modules.sysfs
      • salt.modules.syslog_ng
      • salt.modules.sysmod
      • salt.modules.sysrc
      • salt.modules.system
      • salt.modules.system_profiler
      • salt.modules.systemd_service
      • salt.modules.telegram
      • salt.modules.telemetry
      • salt.modules.temp
      • salt.modules.test
      • salt.modules.test_virtual
      • salt.modules.testinframod
      • salt.modules.textfsm_mod
      • salt.modules.timezone
      • salt.modules.tls
      • salt.modules.tomcat
      • salt.modules.trafficserver
      • salt.modules.transactional_update module
      • salt.modules.travisci
      • salt.modules.tuned
      • salt.modules.twilio_notify
      • salt.modules.udev
      • salt.modules.upstart_service
      • salt.modules.uptime
      • salt.modules.useradd
      • salt.modules.uwsgi
      • salt.modules.vagrant
      • salt.modules.varnish
      • salt.modules.vault
      • salt.modules.vbox_guest
      • salt.modules.vboxmanage
      • salt.modules.vcenter
      • salt.modules.victorops
      • salt.modules.virt
      • salt.modules.virtualenv
      • salt.modules.vmctl
      • salt.modules.vsphere
      • salt.modules.webutil
      • salt.modules.win_auditpol
      • salt.modules.win_autoruns
      • salt.modules.win_certutil
      • salt.modules.win_dacl
      • salt.modules.win_disk
      • salt.modules.win_dism
      • salt.modules.win_dns_client
      • salt.modules.win_dsc
      • salt.modules.win_event
      • salt.modules.win_file
      • salt.modules.win_firewall
      • salt.modules.win_groupadd
      • salt.modules.win_iis
      • salt.modules.win_ip
      • salt.modules.win_lgpo
      • salt.modules.win_lgpo_reg
      • salt.modules.win_license
      • salt.modules.win_network
      • salt.modules.win_ntp
      • salt.modules.win_path
      • salt.modules.win_pkg
      • salt.modules.win_pki
      • salt.modules.win_powercfg
      • salt.modules.win_psget
      • salt.modules.win_servermanager
      • salt.modules.win_service
      • salt.modules.win_shadow
      • salt.modules.win_shortcut
      • salt.modules.win_smtp_server
      • salt.modules.win_snmp
      • salt.modules.win_status
      • salt.modules.win_system
      • salt.modules.win_task
      • salt.modules.win_timezone
      • salt.modules.win_useradd
      • salt.modules.win_wua
      • salt.modules.win_wusa
      • salt.modules.winrepo
      • salt.modules.wordpress
      • salt.modules.x509
      • salt.modules.x509_v2
      • salt.modules.xapi_virt
      • salt.modules.xbpspkg
      • salt.modules.xfs
      • salt.modules.xml
      • salt.modules.xmpp
      • salt.modules.yaml
      • salt.modules.yumpkg
      • salt.modules.zabbix
      • salt.modules.zcbuildout
      • salt.modules.zenoss
      • salt.modules.zfs
      • salt.modules.zk_concurrency
      • salt.modules.znc
      • salt.modules.zoneadm
      • salt.modules.zonecfg
      • salt.modules.zookeeper
      • salt.modules.zpool
      • salt.modules.zypperpkg
    • executors modules
    • fileserver modules
    • grains modules
    • netapi modules
    • output modules
    • pillar modules
    • proxy modules
    • queue modules
    • renderer modules
    • returner modules
    • roster modules
    • runner modules
    • sdb modules
    • serializer modules
    • state modules
    • thorium modules
    • token modules
    • master tops modules
    • wheel modules
  • APIs
  • Architecture
  • Minion Data Cache
  • Slots
  • Windows
  • Developing Salt
  • Release notes
  • Venafi Tools for Salt
  • Glossary