Function add

salt/modules/win_useradd.py:74–169 · view source on GitHub ↗

Add a user to the minion. Args: name (str): The username for the new account. password (:obj:`str`, optional): User's password in plain text. Default is ``None``. fullname (:obj:`str`, optional): The user's full name. Default is ``None``

(
    name,
    password=None,
    fullname=None,
    description=None,
    groups=None,
    home=None,
    homedrive=None,
    profile=None,
    logonscript=None,
)

Source from the content-addressed store, hash-verified

72
73
74	def add(
75	name,
76	password=None,
77	fullname=None,
78	description=None,
79	groups=None,
80	home=None,
81	homedrive=None,
82	profile=None,
83	logonscript=None,
84	):
85	"""
86	Add a user to the minion.
87
88	Args:
89
90	name (str): The username for the new account.
91
92	password (:obj:`str`, optional): User's password in plain text.
93
94	Default is ``None``.
95
96	fullname (:obj:`str`, optional): The user's full name.
97
98	Default is ``None``.
99
100	description (:obj:`str`, optional):
101	A brief description of the user account.
102
103	Default is ``None``.
104
105	groups (:obj:`str`, optional):
106	A list of groups to add the user to. (see chgroups)
107
108	Default is ``None``.
109
110	home (:obj:`str`, optional):
111	The path to the user's home directory.
112
113	Default is ``None``.
114
115	homedrive (:obj:`str`, optional):
116	The drive letter to assign to the home directory. Must be the Drive
117	Letter followed by a colon. ie: ``U:``.
118
119	Default is ``None``.
120
121	profile (:obj:`str`, optional):
122	An explicit path to a profile. Can be a UNC or a folder on the
123	system. If left blank, windows uses its default profile directory.
124
125	Default is ``None``.
126
127	logonscript (:obj:`str`, optional):
128	Path to a login script to run when the user logs on.
129
130	Default is ``None``.
131

Callers

nothing calls this directly

Calls 3

updateFunction · 0.70

chgroupsFunction · 0.70

errorMethod · 0.45

Tested by

no test coverage detected