Class: Ansible::Ruby::Modules::Win_domain_membership

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

Overview

Manages domain membership or workgroup membership for a Windows host. Also supports hostname changes. 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

#dns_domain_name ⇒ Object?

Returns When C(state) is C(domain), the DNS name of the domain to which the targeted Windows host should be joined.

Returns:

  • (Object, nil) —

    When C(state) is C(domain), the DNS name of the domain to which the targeted Windows host should be joined.



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_membership.rb', line 13

attribute :dns_domain_name

#domain_admin_password ⇒ Object?

Returns Password for the specified C(domain_admin_user).

Returns:

  • (Object, nil) —

    Password for the specified C(domain_admin_user).



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

attribute :domain_admin_password

#domain_admin_user ⇒ Object

Returns Username of a domain admin for the target domain (required to join or leave the domain).

Returns:

  • (Object) —

    Username of a domain admin for the target domain (required to join or leave the domain).



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

attribute :domain_admin_user

#domain_ou_path ⇒ Object?

Returns The desired OU path for adding the computer object.,This is only used when adding the target host to a domain, if it is already a member then it is ignored.

Returns:

  • (Object, nil) —

    The desired OU path for adding the computer object.,This is only used when adding the target host to a domain, if it is already a member then it is ignored.



26
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_membership.rb', line 26

attribute :domain_ou_path

#hostname ⇒ Object?

Returns The desired hostname for the Windows host.

Returns:

  • (Object, nil) —

    The desired hostname for the Windows host.



23
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_membership.rb', line 23

attribute :hostname

#state ⇒ :domain, ...

Returns Whether the target host should be a member of a domain or workgroup.

Returns:

  • (:domain, :workgroup, nil) —

    Whether the target host should be a member of a domain or workgroup.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_membership.rb', line 29

attribute :state

#workgroup_name ⇒ Object?

Returns When C(state) is C(workgroup), the name of the workgroup that the Windows host should be in.

Returns:

  • (Object, nil) —

    When C(state) is C(workgroup), the name of the workgroup that the Windows host should be in.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_domain_membership.rb', line 33

attribute :workgroup_name