community.windows.win_netbios module – Manage NetBIOS over TCP/IP settings on Windows.

Note

This module is part of the community.windows collection (version 1.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.windows.

To use it in a playbook, specify: community.windows.win_netbios.

Synopsis

  • Enables or disables NetBIOS on Windows network adapters.

  • Can be used to protect a system against NBT-NS poisoning and avoid NBNS broadcast storms.

  • Settings can be applied system wide or per adapter.

Parameters

Parameter

Comments

adapter_names

list / elements=string

List of adapter names for which to manage NetBIOS settings. If this option is omitted then configuration is applied to all adapters on the system.

The adapter name used is the connection caption in the Network Control Panel or via Get-NetAdapter, eg Ethernet 2.

state

string / required

Whether NetBIOS should be enabled, disabled, or default (use setting from DHCP server or if static IP address is assigned enable NetBIOS).

Choices:

  • enabled

  • disabled

  • default

Notes

Note

  • Changing NetBIOS settings does not usually require a reboot and will take effect immediately.

  • UDP port 137/138/139 will no longer be listening once NetBIOS is disabled.

Examples

- name: Disable NetBIOS system wide
  community.windows.win_netbios:
    state: disabled

- name: Disable NetBIOS on Ethernet2
  community.windows.win_netbios:
    state: disabled
    adapter_names:
      - Ethernet2

- name: Enable NetBIOS on Public and Backup adapters
  community.windows.win_netbios:
    state: enabled
    adapter_names:
      - Public
      - Backup

- name: Set NetBIOS to system default on all adapters
  community.windows.win_netbios:
    state: default

Return Values

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

Key

Description

reboot_required

boolean

Boolean value stating whether a system reboot is required.

Returned: always

Sample: true

Authors

  • Thomas Moore (@tmmruk)