salt/doc/ref/modules/all/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

560 lines
7.7 KiB
ReStructuredText
Raw Normal View History

.. _all-salt.modules:
=================
execution modules
=================
.. admonition:: Virtual modules
.. toctree::
salt.modules.group
salt.modules.kernelpkg
salt.modules.pkg
salt.modules.service
salt.modules.shadow
salt.modules.sysctl
salt.modules.user
.. currentmodule:: salt.modules
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
acme
aix_group
aix_shadow
2019-06-04 13:14:43 -06:00
aixpkg
2012-05-26 08:31:38 -06:00
aliases
alternatives
2018-10-13 18:57:34 -05:00
ansiblegate
apache
apcups
apf
apkpkg
aptly
aptpkg
archive
arista_pyeapi
2014-12-08 10:34:33 -05:00
artifactory
at
at_solaris
2012-07-10 16:46:49 +02:00
augeas_cfg
aws_sqs
bamboohr
2020-04-18 06:57:48 +01:00
baredoc
bcache
beacons
bigip
bluez_bluetooth
boto3_elasticache
2019-07-08 18:29:01 +02:00
boto3_elasticsearch
boto3_route53
boto3_sns
boto_apigateway
boto_asg
boto_cfn
2017-09-27 14:26:32 -06:00
boto_cloudfront
boto_cloudtrail
boto_cloudwatch
boto_cloudwatch_event
boto_cognitoidentity
boto_datapipeline
2015-02-25 12:50:44 -08:00
boto_dynamodb
boto_ec2
boto_efs
boto_elasticache
boto_elasticsearch_domain
boto_elb
boto_elbv2
boto_iam
boto_iot
boto_kinesis
2015-06-03 15:18:52 -07:00
boto_kms
boto_lambda
2015-02-25 12:50:44 -08:00
boto_rds
boto_route53
boto_s3
boto_s3_bucket
boto_secgroup
boto_sns
boto_sqs
boto_ssm
boto_vpc
2015-02-21 05:56:20 +00:00
bower
2013-06-06 16:39:22 -06:00
bridge
bsd_shadow
btrfs
cabal
2017-03-09 16:34:20 +00:00
capirca_acl
cassandra_cql
cassandra_mod
celery
ceph
2015-10-16 16:52:14 -06:00
chassis
chef
2013-10-18 13:09:54 -05:00
chocolatey
chronos
chroot
2018-01-18 11:21:42 -05:00
cimc
2018-07-24 12:49:28 +00:00
ciscoconfparse_mod
cisconso
cloud
cmdmod
composer
config
consul
container_resource
cp
cpan
cron
cryptdev
csf
cyg
2012-10-29 18:28:35 -06:00
daemontools
data
datadog_api
ddns
deb_apache
deb_postgres
debconfmod
debian_ip
2012-07-24 00:49:17 +02:00
debian_service
debuild_pkgbuild
defaults
devinfo
devmap
2013-06-06 16:39:22 -06:00
dig
disk
djangomod
dnsmasq
dnsutil
dockercompose
dockermod
dpkg_lowpkg
drac
2015-10-16 16:52:14 -06:00
dracr
drbd
dummyproxy_pkg
dummyproxy_service
ebuildpkg
2013-01-02 22:30:43 +00:00
eix
elasticsearch
environ
2013-06-06 16:39:22 -06:00
eselect
esxcluster
esxdatacenter
esxi
esxvm
2014-03-25 08:24:15 -06:00
etcd_mod
ethtool
event
2012-12-02 16:09:43 -07:00
extfs
file
firewalld
2013-08-21 00:10:26 +01:00
freebsd_sysctl
freebsd_update
2012-05-26 08:35:53 -06:00
freebsdjail
freebsdkmod
freebsdpkg
2013-10-15 13:00:47 -05:00
freebsdports
freebsdservice
freezer
gcp_addon
gem
genesis
gentoo_service
2013-08-21 00:10:26 +01:00
gentoolkitmod
git
github
2018-05-04 16:49:05 -05:00
glanceng
glassfish
glusterfs
gnomedesktop
google_chat
gpg
grafana4
grains
groupadd
2012-12-02 16:09:43 -07:00
grub_legacy
guestfs
hadoop
haproxyconn
2014-07-25 20:06:54 -06:00
hashutil
heat
helm
hg
highstate_doc
hosts
http
icinga2
2020-08-03 18:21:05 -06:00
idem
ifttt
ilo
incron
influxdb08mod
influxdbmod
infoblox
ini_manage
inspectlib
inspectlib.collector
inspectlib.dbhandle
inspectlib.entities
inspectlib.exceptions
inspectlib.fsdb
inspectlib.kiwiproc
inspectlib.query
inspector
introspect
2018-08-01 13:06:00 +00:00
iosconfig
ipmi
ipset
2012-12-02 16:09:43 -07:00
iptables
iwtools
2014-12-08 10:34:33 -05:00
jboss7
jboss7_cli
jenkinsmod
jinja
2018-07-20 12:19:48 +00:00
jira_mod
junos
k8s
kapacitor
kerberos
kernelpkg_linux_apt
kernelpkg_linux_yum
key
2013-08-21 00:10:26 +01:00
keyboard
keystone
2018-05-04 16:49:05 -05:00
keystoneng
keystore
kmod
kubeadm
2019-03-01 13:52:27 -06:00
kubernetesmod
launchctl_service
2013-01-02 22:31:53 +00:00
layman
ldap3
ldapmod
2017-04-30 20:32:44 +10:00
libcloud_compute
libcloud_dns
libcloud_loadbalancer
libcloud_storage
linux_acl
linux_ip
linux_lvm
linux_service
linux_shadow
linux_sysctl
localemod
locate
2014-07-24 15:28:11 -06:00
logadm
2017-03-16 14:00:39 +00:00
logmod
logrotate
lvs
lxc
2019-09-18 18:06:26 -07:00
lxd
mac_assistive
mac_brew_pkg
mac_desktop
mac_group
mac_keychain
mac_pkgutil
mac_portspkg
mac_power
mac_service
mac_shadow
mac_softwareupdate
mac_sysctl
mac_system
mac_timezone
mac_user
mac_xattr
macdefaults
macpackage
2013-01-05 02:14:08 -05:00
makeconf
2017-11-14 10:28:30 +00:00
mandrill
marathon
match
mattermost
mdadm_raid
2016-01-29 16:25:51 +00:00
mdata
memcached
mine
minion
2014-07-24 15:28:11 -06:00
mod_random
modjk
mongodb
monit
moosefs
mount
2015-02-03 10:02:09 -05:00
mssql
msteams
munin
mysql
nacl
nagios
nagios_rpc
namecheap_domains
namecheap_domains_dns
namecheap_domains_ns
namecheap_ssl
namecheap_users
napalm_bgp
2018-08-02 10:29:27 +00:00
napalm_formula
napalm_mod
napalm_netacl
napalm_network
2016-03-22 11:40:12 +00:00
napalm_ntp
napalm_probes
2016-11-01 14:56:23 +00:00
napalm_route
2016-11-01 13:17:37 +00:00
napalm_snmp
2016-11-01 14:11:59 +00:00
napalm_users
2017-04-01 02:39:52 +00:00
napalm_yang_mod
netaddress
2018-02-09 09:44:07 +00:00
netbox
netbsd_sysctl
2013-08-21 00:10:26 +01:00
netbsdservice
netmiko_mod
netscaler
network
neutron
2018-05-04 16:49:05 -05:00
neutronng
nexus
nfs3
nftables
nginx
nilrt_ip
nix
nova
npm
nspawn
2016-04-14 15:28:18 -06:00
nxos
2018-07-12 08:54:02 +00:00
nxos_api
merge nxos-specific work from develop into master. (#54931) * Combine proxy and native minion workflows for NXOS - Normalize SSH and NX-API proxy minion workflows - Add NX-API over unix domain socket support for native minions * Fix typo * Fix states correct_roles bug * Add comment clarification for nxos states * Fix lint issues * Address python3 incompatibility * Fix additional lint issues * Disable pylint W1699 warning * Use new style class syntax * Correct typo * Fix nxos grains * Pass data to grains function * Return nxos grains key * Protect nxos grain with proper __virtual__() check The changes in PR #49676 made the following stacktrace occur when running on a system that doesn't have the proper NXOS/NXAPIClient settings exposed: ``` [CRITICAL] Failed to load grains defined in grain file nxos.system_information in function <function system_information at 0x3aeb758>, error: Traceback (most recent call last): File "/testing/salt/loader.py", line 773, in grains ret = funcs[key](**kwargs) File "/testing/salt/grains/nxos.py", line 36, in system_information data = salt.utils.nxos.version_info() File "/testing/salt/utils/nxos.py", line 318, in version_info client = NxapiClient() File "/testing/salt/utils/nxos.py", line 78, in __init__ raise RuntimeError("No host specified and no UDS found at {0}\n".format(self.NXAPI_UDS)) RuntimeError: No host specified and no UDS found at /tmp/nginx_local/nginx_1_be_nxapi.sock local: True ``` We need to protect the grains from loading when the settings are missing. * Initial nxos_upgrade changes * Revert "Initial nxos_upgrade changes" This reverts commit e17ca19fbc9221145b79210c222b03d753bbd1f3. * New NX-OS salt minion install doc * Add guestshell sync information * Initial nxos_upgrade changes * Initial nxos_upgrade changes * Revert "Initial nxos_upgrade changes" This reverts commit e17ca19fbc9221145b79210c222b03d753bbd1f3. * Revert "Initial nxos_upgrade changes" This reverts commit e17ca19fbc9221145b79210c222b03d753bbd1f3. * Add nxos to index.rst * New nxos_upgrade execution and state modules * Added NXOS UT support - initially for nxos_upgrade.py * Resolved one pylint 'old class style' issue. Excluding 'nxos' sub-directory under tests/unit/modules * Add __init__.py file to treat directory as a package directory. * Addressed PR comments. * Removed pylint disable-msg that was only applicable to python 3+ * Document NAPALM installation inside Guestshell Adding step-by-step guide to install NAPALM inside of the NXOS Guestshell. * show and sendline method fixes * Update doc for starting minion in nxos GuestShell * Revert show method changes * Revert sendline method doc changes * Resolve lint errors * Remove nxos guestshell napalm references This work is delayed so removing the references * Address review comments * Address salt style guide comment * Doc and module updates * Initial nxos module and proxy unit tests * Additional nxos module and proxy unit tests * Add nxos state unit tests * Add tests for replace function * Bug fixes * Fix test_check_password_password_encrypted_false test * Add test_config_nxos_error_ssh test * remove opts modification in init * reduce scope of variable to function where it's used * minor nxos cleanup - raise instead of exit, use named kwargs * use create_autospec in place of raw mocks * _init_ssh's raise is now caught by ping * allow gen_hash to work on any system * change no_save_config option to save_config * update set_password to work with updated gen_hash * passing an invalid algorithm to pycrypto.hash raises * blacken nxos-related files * _fallback_gen_hash also works without a password * remove debugging line, improve error message * lint and black * nxos docfix * remove unused variable * Review comments addressed * mark old nxos functions as deprecated * black * remove unused variables * clean up arguments * simplify save_config logic * minor doc cleanup * make sendline with a list of commands reliably work * Update various doc index files for nxos_upgrade * Fix a few bugs in nxos proxy and execution modules * doc indent fix Co-authored-by: mikewiebe <mwiebe@cisco.com> Co-authored-by: rallytime <nicole@saltstack.com> Co-authored-by: Thomas Stoner <tmstoner@cisco.com> Co-authored-by: tstoner <33665760+tstoner@users.noreply.github.com> Co-authored-by: Chris Van Heuveln <cvanheuv@cisco.com>
2020-05-04 04:13:07 -04:00
nxos_upgrade
2013-10-15 14:07:24 -06:00
omapi
openbsd_sysctl
openbsdpkg
openbsdrcctl_service
openbsdservice
openscap
openstack_config
openstack_mng
openvswitch
opkg
opsgenie
2014-07-24 15:28:11 -06:00
oracle
osquery
2017-06-29 17:01:53 +00:00
out
pacmanpkg
2013-12-25 08:44:19 -06:00
pagerduty
pagerduty_util
2012-12-02 16:09:43 -07:00
pam
2018-01-18 11:11:43 -05:00
panos
2016-04-14 15:28:18 -06:00
parallels
parted_partition
2016-04-14 15:28:18 -06:00
pcs
2016-10-21 18:27:36 +00:00
pdbedit
pecl
peeringdb
pf
philips_hue
pillar
pip
2013-08-21 00:10:26 +01:00
pkg_resource
2013-06-06 16:39:22 -06:00
pkgin
pkgng
2012-10-25 11:52:39 -06:00
pkgutil
portage_config
2014-06-02 10:20:58 -06:00
postfix
2012-05-26 08:47:50 -06:00
postgres
poudriere
2013-10-15 14:07:24 -06:00
powerpath
proxy
ps
publish
puppet
2017-09-27 14:26:32 -06:00
purefa
purefb
pushbullet
pushover_notify
pw_group
pw_user
2014-07-24 15:28:11 -06:00
pyenv
qemu_img
qemu_nbd
quota
2012-10-25 11:52:39 -06:00
rabbitmq
rallydev
random_org
rbac_solaris
2013-06-06 16:39:22 -06:00
rbenv
2013-10-15 14:07:24 -06:00
rdp
rebootmgr
2014-05-13 15:07:30 -05:00
redismod
2014-07-24 15:28:11 -06:00
reg
rest_pkg
rest_sample_utils
rest_service
restartcheck
2020-11-18 16:16:48 +00:00
restconf
ret
rh_ip
rh_service
2013-10-15 14:07:24 -06:00
riak
rpm_lowpkg
rpmbuild_pkgbuild
2014-02-20 04:21:17 -06:00
rsync
runit
rvm
s3
s6
salt_proxy
salt_version
2018-06-18 09:48:37 -04:00
saltcheck
2013-10-15 14:07:24 -06:00
saltcloudmod
saltutil
2014-07-24 15:28:11 -06:00
schedule
2018-08-01 14:35:44 +00:00
scp_mod
scsi
sdb
seed
selinux
sensehat
2014-07-24 15:28:11 -06:00
sensors
2014-06-11 18:00:14 -05:00
serverdensity_device
servicenow
slack_notify
slackware_service
2016-01-22 09:13:06 -07:00
slsutil
2013-06-06 16:39:22 -06:00
smartos_imgadm
smartos_nictagadm
smartos_virt
2013-06-06 16:39:22 -06:00
smartos_vmadm
smbios
smf_service
smtp
snapper
solaris_fmadm
2012-10-25 11:52:39 -06:00
solaris_group
solaris_shadow
solaris_system
2012-10-25 11:52:39 -06:00
solaris_user
solarisipspkg
2013-08-21 00:10:26 +01:00
solarispkg
solr
solrcloud
2015-08-04 16:33:37 -07:00
splunk
splunk_search
2012-05-26 08:58:27 -06:00
sqlite3
ssh
ssh_pkg
ssh_service
state
status
2017-01-05 16:54:05 +00:00
statuspage
supervisord
suse_apache
2021-08-10 12:57:21 +03:00
suse_ip
svn
swarm
swift
sysbench
sysfs
syslog_ng
sysmod
sysrc
system
system_profiler
systemd_service
telegram
2015-08-04 16:33:37 -07:00
telemetry
temp
test
test_virtual
testinframod
2017-09-27 14:26:32 -06:00
textfsm_mod
2012-12-02 16:09:43 -07:00
timezone
2012-10-29 18:27:47 -06:00
tls
tomcat
trafficserver
transactional_update
travisci
tuned
twilio_notify
udev
upstart_service
uptime
useradd
uwsgi
2017-09-18 21:33:15 -06:00
vagrant
2014-06-02 11:04:42 -05:00
varnish
vault
vbox_guest
vboxmanage
vcenter
victorops
virt
virtualenv_mod
2018-01-24 16:49:40 +01:00
vmctl
vsphere
webutil
win_auditpol
2013-10-15 14:07:24 -06:00
win_autoruns
win_certutil
win_dacl
win_disk
win_dism
2013-10-15 14:07:24 -06:00
win_dns_client
win_dsc
win_event
2012-03-18 14:29:51 -07:00
win_file
2013-10-15 14:07:24 -06:00
win_firewall
2012-05-26 09:05:42 -06:00
win_groupadd
win_iis
2013-10-15 14:07:24 -06:00
win_ip
win_lgpo
win_lgpo_reg
win_license
2012-03-18 14:29:51 -07:00
win_network
2013-10-09 21:00:37 -05:00
win_ntp
2013-10-15 14:07:24 -06:00
win_path
2012-05-26 09:10:18 -06:00
win_pkg
win_pki
win_powercfg
win_psget
2013-10-15 14:07:24 -06:00
win_servermanager
win_service
2012-03-18 14:29:51 -07:00
win_shadow
2022-05-04 17:39:36 -06:00
win_shortcut
win_smtp_server
win_snmp
win_status
2013-06-06 16:39:22 -06:00
win_system
win_task
2013-10-15 14:07:24 -06:00
win_timezone
win_useradd
2015-07-10 09:54:08 -06:00
win_wua
2019-10-07 17:31:11 -06:00
win_wusa
winrepo
wordpress
2015-03-26 13:22:26 -04:00
x509
2022-11-22 20:57:40 +01:00
x509_v2
xapi_virt
xbpspkg
xfs
xml
2013-12-24 17:58:09 -06:00
xmpp
yaml
2014-01-17 21:08:44 -06:00
yumpkg
zabbix
zcbuildout
zenoss
2013-06-06 16:39:22 -06:00
zfs
zk_concurrency
2014-02-24 13:58:54 -06:00
znc
zoneadm
2016-11-19 14:51:55 +01:00
zonecfg
2018-06-06 00:49:37 -05:00
zookeeper
zpool
zypperpkg