MCPcopy
hub / github.com/saltstack/salt / update

Function update

salt/modules/win_useradd.py:172–356  ·  view source on GitHub ↗

Updates settings for the Windows user. Name is the only required parameter. Settings will only be changed if the parameter is passed a value. .. versionadded:: 2015.8.0 Args: name (str): The username to update. password (:obj:`str`, optional): New use

(
    name,
    password=None,
    fullname=None,
    description=None,
    home=None,
    homedrive=None,
    logonscript=None,
    profile=None,
    expiration_date=None,
    expired=None,
    account_disabled=None,
    unlock_account=None,
    password_never_expires=None,
    disallow_change_password=None,
)

Source from the content-addressed store, hash-verified

170
171
172def update(
173 name,
174 password=None,
175 fullname=None,
176 description=None,
177 home=None,
178 homedrive=None,
179 logonscript=None,
180 profile=None,
181 expiration_date=None,
182 expired=None,
183 account_disabled=None,
184 unlock_account=None,
185 password_never_expires=None,
186 disallow_change_password=None,
187):
188 # pylint: disable=anomalous-backslash-in-string
189 """
190 Updates settings for the Windows user. Name is the only required parameter.
191 Settings will only be changed if the parameter is passed a value.
192
193 .. versionadded:: 2015.8.0
194
195 Args:
196
197 name (str): The username to update.
198
199 password (:obj:`str`, optional):
200 New user password in plain text.
201
202 Default is ``None``.
203
204 fullname (:obj:`str`, optional):
205 The user's full name.
206
207 Default is ``None``.
208
209 description (:obj:`str`, optional):
210 A brief description of the user account.
211
212 Default is ``None``.
213
214 home (:obj:`str`, optional):
215 The path to the user's home directory.
216
217 Default is ``None``.
218
219 homedrive (:obj:`str`, optional):
220 The drive letter to assign to the home directory. Must be the Drive
221 Letter followed by a colon. ie: ``U:``.
222
223 Default is ``None``.
224
225 logonscript (:obj:`str`, optional):
226 The path to the logon script.
227
228 Default is ``None``.
229

Callers 5

addFunction · 0.70
setpasswordFunction · 0.70
chhomeFunction · 0.70
chprofileFunction · 0.70
chfullnameFunction · 0.70

Calls 1

errorMethod · 0.45

Tested by

no test coverage detected