community.windows.win_auto_logon (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

Used to apply auto logon registry setting.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set autologon for user1
  community.windows.win_auto_logon:
    username: User1
    password: str0ngp@ssword

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set autologon for abc.com\user1
  community.windows.win_auto_logon:
    username: abc.com\User1
    password: str0ngp@ssword

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove autologon for user1
  community.windows.win_auto_logon:
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set autologon for user1 with a limited logon count
  community.windows.win_auto_logon:
    username: User1
    password: str0ngp@ssword
    logon_count: 5

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description:
    - Whether the registry key should be C(present) or C(absent).
    type: str

password:
    description:
    - Password to be used for automatic login.
    - Must be set when C(state=present).
    - Value of this input will be used as password for I(username).
    - While this value is encrypted by LSA it is decryptable to any user who is an Administrator
      on the remote host.
    type: str

username:
    description:
    - Username to login automatically.
    - Must be set when C(state=present).
    - This can be the Netlogon or UPN of a domain account and is automatically parsed
      to the C(DefaultUserName) and C(DefaultDomainName) registry properties.
    type: str

logon_count:
    description:
    - The number of times to do an automatic logon.
    - This count is deremented by Windows everytime an automatic logon is performed.
    - Once the count reaches C(0) then the automatic logon process is disabled.
    type: int