salt.modules.user¶

user is a virtual module that is fulfilled by one of the following modules:

Execution Module	Used for
`useradd`	Linux, NetBSD, and OpenBSD systems using `useradd(8)`, `userdel(8)`, and `usermod(8)`
`pw_user`	FreeBSD-based OSes using `pw(8)`
`solaris_user`	Solaris-based OSes using `useradd(1M)`, `userdel(1M)`, and `usermod(1M)`
`mac_user`	MacOS
`win_useradd`	Windows

Generated on June 18, 2020 at 04:09:58 UTC.

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

saltstack.com

Introduction to Salt
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
Command Line Reference
Pillars
Master Tops
Salt Module Reference
- auth modules
- beacon modules
- cache modules
- cloud modules
- engine modules
- executors modules
- fileserver modules
- grains 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 module
  - salt.modules.aix_group module
  - salt.modules.aix_shadow module
  - 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 module
  - 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 module
  - salt.modules.azurearm_network
  - salt.modules.azurearm_resource
  - salt.modules.bamboohr
  - salt.modules.baredoc module
  - salt.modules.bcache module
  - salt.modules.beacons
  - salt.modules.bigip
  - salt.modules.bluez_bluetooth
  - salt.modules.boto3_elasticache module
  - salt.modules.boto3_elasticsearch module
  - salt.modules.boto3_route53 module
  - salt.modules.boto3_sns module
  - salt.modules.boto_apigateway module
  - salt.modules.boto_asg
  - salt.modules.boto_cfn
  - salt.modules.boto_cloudfront
  - salt.modules.boto_cloudtrail module
  - salt.modules.boto_cloudwatch
  - salt.modules.boto_cloudwatch_event module
  - salt.modules.boto_cognitoidentity module
  - salt.modules.boto_datapipeline module
  - salt.modules.boto_dynamodb
  - salt.modules.boto_ec2
  - salt.modules.boto_efs module
  - salt.modules.boto_elasticache
  - salt.modules.boto_elasticsearch_domain module
  - salt.modules.boto_elb
  - salt.modules.boto_elbv2 module
  - salt.modules.boto_iam
  - salt.modules.boto_iot module
  - salt.modules.boto_kinesis module
  - salt.modules.boto_kms
  - salt.modules.boto_lambda module
  - salt.modules.boto_rds
  - salt.modules.boto_route53
  - salt.modules.boto_s3 module
  - salt.modules.boto_s3_bucket module
  - salt.modules.boto_secgroup
  - salt.modules.boto_sns
  - salt.modules.boto_sqs
  - salt.modules.boto_ssm module
  - salt.modules.boto_vpc
  - salt.modules.bower
  - salt.modules.bridge
  - salt.modules.bsd_shadow
  - salt.modules.btrfs
  - salt.modules.cabal
  - salt.modules.capirca_acl module
  - salt.modules.cassandra_cql
  - salt.modules.cassandra_mod
  - salt.modules.celery module
  - salt.modules.ceph module
  - salt.modules.chassis
  - salt.modules.chef
  - salt.modules.chocolatey
  - salt.modules.chronos module
  - salt.modules.chroot module
  - salt.modules.cimc module
  - salt.modules.ciscoconfparse_mod module
  - 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 module
  - 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 module
  - salt.modules.dockermod
  - salt.modules.dpkg_lowpkg
  - salt.modules.drac
  - salt.modules.dracr
  - salt.modules.drbd
  - salt.modules.dummyproxy_pkg module
  - salt.modules.dummyproxy_service module
  - salt.modules.ebuildpkg
  - salt.modules.eix
  - salt.modules.elasticsearch
  - salt.modules.environ
  - salt.modules.eselect
  - salt.modules.esxcluster module
  - salt.modules.esxdatacenter module
  - salt.modules.esxi
  - salt.modules.esxvm module
  - salt.modules.etcd_mod
  - salt.modules.ethtool module
  - salt.modules.event
  - salt.modules.extfs
  - salt.modules.file
  - salt.modules.firewalld
  - salt.modules.freebsd_sysctl
  - salt.modules.freebsd_update module
  - salt.modules.freebsdjail
  - salt.modules.freebsdkmod
  - salt.modules.freebsdpkg
  - salt.modules.freebsdports
  - salt.modules.freebsdservice
  - salt.modules.freezer module
  - salt.modules.gcp_addon module
  - salt.modules.gem
  - salt.modules.genesis
  - salt.modules.gentoo_service
  - salt.modules.gentoolkitmod
  - salt.modules.git
  - salt.modules.github module
  - salt.modules.glance
  - salt.modules.glanceng
  - salt.modules.glassfish module
  - salt.modules.glusterfs
  - salt.modules.gnomedesktop
  - salt.modules.google_chat
  - salt.modules.gpg
  - salt.modules.grafana4 module
  - 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 module
  - salt.modules.helm module
  - salt.modules.hg
  - salt.modules.highstate_doc module
  - salt.modules.hosts
  - salt.modules.http
  - salt.modules.icinga2 module
  - 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 module
  - salt.modules.inspectlib.dbhandle module
  - salt.modules.inspectlib.entities module
  - salt.modules.inspectlib.exceptions module
  - salt.modules.inspectlib.fsdb module
  - salt.modules.inspectlib.kiwiproc module
  - salt.modules.inspectlib.query module
  - salt.modules.inspector module
  - salt.modules.introspect
  - salt.modules.iosconfig module
  - salt.modules.ipmi
  - salt.modules.ipset
  - salt.modules.iptables
  - salt.modules.iwtools module
  - salt.modules.jboss7
  - salt.modules.jboss7_cli
  - salt.modules.jenkinsmod module
  - salt.modules.jinja
  - salt.modules.jira_mod module
  - salt.modules.junos
  - salt.modules.k8s
  - salt.modules.kapacitor module
  - 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 module
  - salt.modules.kubernetesmod
  - salt.modules.launchctl_service
  - salt.modules.layman
  - salt.modules.ldap3
  - salt.modules.ldapmod
  - salt.modules.libcloud_compute module
  - salt.modules.libcloud_dns module
  - salt.modules.libcloud_loadbalancer
  - salt.modules.libcloud_storage
  - salt.modules.linux_acl
  - salt.modules.linux_ip module
  - 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 module
  - salt.modules.logrotate
  - salt.modules.lvs
  - salt.modules.lxc
  - salt.modules.lxd
  - salt.modules.mac_assistive module
  - salt.modules.mac_brew_pkg
  - salt.modules.mac_desktop module
  - salt.modules.mac_group
  - salt.modules.mac_keychain module
  - salt.modules.mac_pkgutil module
  - salt.modules.mac_portspkg
  - salt.modules.mac_power module
  - salt.modules.mac_service module
  - salt.modules.mac_shadow module
  - salt.modules.mac_softwareupdate module
  - salt.modules.mac_sysctl module
  - salt.modules.mac_system module
  - salt.modules.mac_timezone module
  - salt.modules.mac_user
  - salt.modules.mac_xattr module
  - salt.modules.macdefaults
  - salt.modules.macpackage
  - salt.modules.makeconf
  - salt.modules.mandrill
  - salt.modules.marathon module
  - salt.modules.match
  - salt.modules.mattermost module
  - salt.modules.mdadm_raid
  - salt.modules.mdata
  - salt.modules.memcached
  - salt.modules.mine
  - salt.modules.minion module
  - 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 module
  - salt.modules.munin
  - salt.modules.mysql
  - salt.modules.nacl
  - salt.modules.nagios
  - salt.modules.nagios_rpc
  - salt.modules.namecheap_domains module
  - salt.modules.namecheap_domains_dns
  - salt.modules.namecheap_domains_ns
  - salt.modules.namecheap_ssl module
  - salt.modules.namecheap_users module
  - salt.modules.napalm_bgp module
  - salt.modules.napalm_formula module
  - salt.modules.napalm_mod module
  - salt.modules.napalm_netacl
  - salt.modules.napalm_network module
  - salt.modules.napalm_ntp module
  - salt.modules.napalm_probes module
  - salt.modules.napalm_route module
  - salt.modules.napalm_snmp module
  - salt.modules.napalm_users module
  - salt.modules.napalm_yang_mod module
  - salt.modules.netaddress
  - salt.modules.netbox module
  - 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 module
  - salt.modules.nfs3
  - salt.modules.nftables
  - salt.modules.nginx
  - salt.modules.nilrt_ip module
  - salt.modules.nix
  - salt.modules.nova
  - salt.modules.npm
  - salt.modules.nspawn
  - salt.modules.nxos module
  - salt.modules.nxos_api module
  - salt.modules.nxos_upgrade module
  - salt.modules.omapi
  - salt.modules.openbsd_sysctl
  - salt.modules.openbsdpkg
  - salt.modules.openbsdrcctl_service.py
  - salt.modules.openbsdservice
  - salt.modules.openscap module
  - salt.modules.openstack_config
  - salt.modules.openstack_mng module
  - salt.modules.openvswitch module
  - salt.modules.opkg module
  - salt.modules.opsgenie
  - salt.modules.oracle
  - salt.modules.osquery
  - salt.modules.out module
  - salt.modules.pacmanpkg
  - salt.modules.pagerduty
  - salt.modules.pagerduty_util
  - salt.modules.pam
  - salt.modules.panos
  - salt.modules.parallels module
  - salt.modules.parted_partition
  - salt.modules.pcs module
  - salt.modules.pdbedit
  - salt.modules.pecl
  - salt.modules.peeringdb module
  - salt.modules.pf
  - salt.modules.philips_hue module
  - 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 module
  - salt.modules.ps
  - salt.modules.publish
  - salt.modules.puppet
  - salt.modules.purefa
  - salt.modules.purefb
  - salt.modules.pushbullet module
  - 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.redis
  - salt.modules.reg
  - salt.modules.rest_pkg
  - salt.modules.rest_sample_utils module
  - salt.modules.rest_service
  - salt.modules.restartcheck module
  - 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 module
  - salt.modules.salt_proxy module
  - salt.modules.salt_version
  - salt.modules.saltcheck
  - salt.modules.saltcloudmod
  - salt.modules.saltutil
  - salt.modules.schedule
  - salt.modules.scp module
  - 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 module
  - salt.modules.slack_notify
  - salt.modules.slsutil
  - salt.modules.smartos_imgadm
  - salt.modules.smartos_nictagadm module
  - salt.modules.smartos_virt
  - salt.modules.smartos_vmadm
  - salt.modules.smbios
  - salt.modules.smf_service
  - salt.modules.smtp
  - salt.modules.snapper module
  - 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 module
  - salt.modules.splunk
  - salt.modules.splunk_search
  - salt.modules.sqlite3
  - salt.modules.ssh
  - salt.modules.ssh_pkg
  - salt.modules.ssh_service module
  - salt.modules.state
  - salt.modules.status
  - salt.modules.statuspage
  - salt.modules.supervisord
  - salt.modules.suse_apache
  - salt.modules.svn
  - salt.modules.swarm
  - salt.modules.swift
  - salt.modules.sysbench
  - salt.modules.sysfs module
  - 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 module
  - salt.modules.textfsm_mod module
  - salt.modules.timezone
  - salt.modules.tls
  - salt.modules.tomcat
  - salt.modules.trafficserver
  - 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 module
  - salt.modules.vbox_guest
  - salt.modules.vboxmanage module
  - salt.modules.vcenter module
  - salt.modules.victorops
  - salt.modules.virt
  - salt.modules.virtualenv
  - salt.modules.vmctl
  - salt.modules.vsphere
  - salt.modules.webutil
  - salt.modules.win_auditpol module
  - salt.modules.win_autoruns
  - salt.modules.win_certutil module
  - salt.modules.win_dacl
  - salt.modules.win_disk
  - salt.modules.win_dism module
  - salt.modules.win_dns_client
  - salt.modules.win_dsc
  - salt.modules.win_file
  - salt.modules.win_firewall
  - salt.modules.win_groupadd
  - salt.modules.win_iis module
  - salt.modules.win_ip
  - salt.modules.win_lgpo module
  - salt.modules.win_license module
  - salt.modules.win_network
  - salt.modules.win_ntp
  - salt.modules.win_path
  - salt.modules.win_pkg
  - salt.modules.win_pki module
  - salt.modules.win_powercfg
  - salt.modules.win_psget module
  - salt.modules.win_servermanager
  - salt.modules.win_service
  - salt.modules.win_shadow
  - salt.modules.win_smtp_server module
  - salt.modules.win_snmp module
  - salt.modules.win_status
  - salt.modules.win_system
  - salt.modules.win_task module
  - salt.modules.win_timezone
  - salt.modules.win_useradd
  - salt.modules.win_wua
  - salt.modules.win_wusa
  - salt.modules.winrepo
  - salt.modules.wordpress module
  - salt.modules.x509
  - salt.modules.xapi_virt
  - salt.modules.xbpspkg module
  - salt.modules.xfs
  - salt.modules.xml
  - salt.modules.xmpp
  - salt.modules.yumpkg
  - salt.modules.zabbix module
  - 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
- 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