Class: Ansible::Ruby::Modules::Win_mapped_drive

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Win_mapped_drive

Defined in:

lib/ansible/ruby/modules/generated/windows/win_mapped_drive.rb

Overview

Allows you to modify mapped network drives for individual users.

Instance Method Summary

• #letter ⇒ String

  The letter of the network path to map to.,This letter must not already be in use with Windows.

• #password ⇒ String^?

  The password for C(username).

• #path ⇒ String^?

  The UNC path to map the drive to.,This is required if C(state=present).,If C(state=absent) and path is not set, the module will delete the mapped drive regardless of the target.,If C(state=absent) and the path is set, the module will throw an error if path does not match the target of the mapped drive.

• #state ⇒ :absent, ...

  If C(present) will ensure the mapped drive exists.,If C(absent) will ensure the mapped drive does not exist.

• #username ⇒ String^?

  Credentials to map the drive with.,The username MUST include the domain or servername like SERVERuser, see the example for more information.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#letter ⇒ String

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

attribute :letter

#password ⇒ String^?

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

attribute :password

#path ⇒ String^?

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

attribute :path

#state ⇒ :absent, ...

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

attribute :state

#username ⇒ String^?

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

attribute :username