Reference Guide

Name Description Schema
netbios_name
optional
NetBIOS name is the network name of the standalone SMB
server. SMB servers joined to Active Directory also have
NetBIOS Name, defaulted to the 15 first characters of the
computer_name attribute. Administrators can specify a
custom NetBIOS Name for an SMB server using this
attribute. NetBIOS name is limited to 15 characters and
cannot contain the following characters - - backslash () -
slash mark (/) - colon (:) - asterisk (*) - question mark (?) -
quotation mark ("") - less than sign (<) - greater than sign (>)
- vertical bar (|) as defined by the Microsoft naming
convention (see https://support.microsoft.com/en-us/help/
909264/)
Length : 1 - 15
string
workgroup
optional
Applies to standalone SMB servers only. Windows network
workgroup for the SMB server. Workgroup names are
limited to 15 alphanumeric ASCII characters.
Length : 1 - 15
string
smb_server_unjoin
Argument to ujoin the SMB server from an Active Directory domain. domain_user_name and
domain_password are mandatory if is_skip_AD_unjoin is false
Name Description Schema
domain_pass
word
optional
Password of the domain-user specified to unjoin from the
Active Directory domain.
string (password)
domain_user_
name
optional
Name of a domain-user with sufficient privileges to unjoin
from the Active Directory domain.
string
is_skip_AD_un
join
optional
If set to yes: Will not remove the account from the Active
Directory. This is to be used in case that no DC is available.
Default : false
boolean
smb_share_create
864