Class: Ansible::Ruby::Modules::Win_domain_controller

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb

Overview

Ensure that a Windows Server 2012+ host is configured as a domain controller or demoted to member server. This module may require subsequent use of the M(win_reboot) action if changes are made.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#database_path ⇒ String?

Returns The path to a directory on a fixed disk of the Windows host where the domain database will be created..,If not set then the default path is C(%SYSTEMROOT%NTDS).

Returns:

  • (String, nil) —

    The path to a directory on a fixed disk of the Windows host where the domain database will be created..,If not set then the default path is C(%SYSTEMROOT%NTDS).



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 44

attribute :database_path

#dns_domain_name ⇒ String?

Returns When C(state) is C(domain_controller), the DNS name of the domain for which the targeted Windows host should be a DC.

Returns:

  • (String, nil) —

    When C(state) is C(domain_controller), the DNS name of the domain for which the targeted Windows host should be a DC.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 12

attribute :dns_domain_name

#domain_admin_password ⇒ String

Returns Password for the specified C(domain_admin_user).

Returns:

  • (String) —

    Password for the specified C(domain_admin_user).



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 20

attribute :domain_admin_password

#domain_admin_user ⇒ String

Returns Username of a domain admin for the target domain (necessary to promote or demote a domain controller).

Returns:

  • (String) —

    Username of a domain admin for the target domain (necessary to promote or demote a domain controller).



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 16

attribute :domain_admin_user

#local_admin_password ⇒ String?

Returns Password to be assigned to the local C(Administrator) user (required when C(state) is C(member_server)).

Returns:

  • (String, nil) —

    Password to be assigned to the local C(Administrator) user (required when C(state) is C(member_server)).



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 28

attribute :local_admin_password

#read_only ⇒ :yes, ...

Returns Whether to install the domain controller as a read only replica for an existing domain.

Returns:

  • (:yes, :no, nil) —

    Whether to install the domain controller as a read only replica for an existing domain.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 32

attribute :read_only

#safe_mode_password ⇒ String?

Returns Safe mode password for the domain controller (required when C(state) is C(domain_controller)).

Returns:

  • (String, nil) —

    Safe mode password for the domain controller (required when C(state) is C(domain_controller)).



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 24

attribute :safe_mode_password

#site_name ⇒ String?

Returns Specifies the name of an existing site where you can place the new domain controller.,This option is required when I(read_only) is C(yes).

Returns:

  • (String, nil) —

    Specifies the name of an existing site where you can place the new domain controller.,This option is required when I(read_only) is C(yes).



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 36

attribute :site_name

#state ⇒ :domain_controller, ...

Returns Whether the target host should be a domain controller or a member server.

Returns:

  • (:domain_controller, :member_server, nil) —

    Whether the target host should be a domain controller or a member server.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 40

attribute :state

#sysvol_path ⇒ String?

Returns The path to a directory on a fixed disk of the Windows host where the Sysvol folder will be created.,If not set then the default path is C(%SYSTEMROOT%SYSVOL).

Returns:

  • (String, nil) —

    The path to a directory on a fixed disk of the Windows host where the Sysvol folder will be created.,If not set then the default path is C(%SYSTEMROOT%SYSVOL).



48
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_controller.rb', line 48

attribute :sysvol_path