win_whoami – Get information about the current user and process — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# win_whoami – Get information about the current user and process

New in version 2.5.

- Synopsis
- Notes
- See Also
- Examples
- Return Values
- Status

## Synopsis

- Designed to return the same information as the `whoami /all` command.
- Also includes information missing from `whoami` such as logon metadata like logon rights, id, type.

## Notes

Note

- If running this module with a non admin user, the logon rights will be an empty list as Administrator rights are required to query LSA for the information.

## See Also

See also

win_credential – Manages Windows Credentials in the Credential Manager
  The official documentation on the win_credential module.
win_group_membership – Manage Windows local group membership
  The official documentation on the win_group_membership module.
win_user_right – Manage Windows User Rights
  The official documentation on the win_user_right module.

## Examples

    - name: Get whoami information
      win_whoami:

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
account complex | success | The running account SID details.
| account_name string | success | The account name of the account SID. Sample: Administrator
| domain_name string | success | The domain name of the account SID. Sample: DOMAIN
| sid string | success | The SID in string form. Sample: S-1-5-21-1654078763-769949647-2968445802-500
| type string | success | The type of SID. Sample: User
authentication_package string | success | The name of the authentication package used to authenticate the user in the session. Sample: Negotiate
dns_domain_name string | success | The DNS name of the logon session, this is an empty string if this is not set. Sample: DOMAIN.COM
groups list | success | A list of groups and attributes that the user is a member of. Sample: [{'attributes': ['Mandatory', 'Enabled by default', 'Enabled'], 'domain_name': 'DOMAIN', 'type': 'Group', 'account_name': 'Domain Users', 'sid': 'S-1-5-21-1654078763-769949647-2968445802-513'}, {'attributes': ['Mandatory', 'Enabled by default', 'Enabled', 'Owner'], 'domain_name': 'BUILTIN', 'type': 'Alias', 'account_name': 'Administrators', 'sid': 'S-1-5-32-544'}]
impersonation_level string | success | The impersonation level of the token, only valid if `token_type` is `TokenImpersonation`, see https://msdn.microsoft.com/en-us/library/windows/desktop/aa379572.aspx. Sample: SecurityAnonymous
label complex | success | The mandatory label set to the logon session.
| account_name string | success | The account name of the label SID. Sample: High Mandatory Level
| domain_name string | success | The domain name of the label SID. Sample: Mandatory Label
| sid string | success | The SID in string form. Sample: S-1-16-12288
| type string | success | The type of SID. Sample: Label
login_domain string | success | The name of the domain used to authenticate the owner of the session. Sample: DOMAIN
login_time string | success | The logon time in ISO 8601 format Sample: 2017-11-27T06:24:14.3321665+10:00
logon_id integer | success | The unique identifier of the logon session. Sample: 20470143
logon_server string | success | The name of the server used to authentcate the owner of the logon session. Sample: DC01
logon_type string | success | The logon type that identifies the logon method, see https://msdn.microsoft.com/en-us/library/windows/desktop/aa380129.aspx. Sample: Network
privileges dictionary | success | A dictionary of privileges and their state on the logon token. Sample: {'SeRemoteShutdownPrivilege': 'disabled', 'SeDebugPrivilege': 'enabled', 'SeChangeNotifyPrivileges': 'enabled-by-default'}
rights list | success and running user is a member of the local Administrators group | A list of logon rights assigned to the logon. Sample: ['SeNetworkLogonRight', 'SeInteractiveLogonRight', 'SeBatchLogonRight', 'SeRemoteInteractiveLogonRight']
token_type string | success | The token type to indicate whether it is a primary or impersonation token. Sample: TokenPrimary
upn string | success | The user principal name of the current user. Sample: Administrator@DOMAIN.COM
user_flags string | success | The user flags for the logon session, see UserFlags in https://msdn.microsoft.com/en-us/library/windows/desktop/aa380128. Sample: Winlogon

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Jordan Borean (@jborean93)

Hint

If you notice any issues in this documentation you can edit this document to improve it.