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

Inherits:
Base show all
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 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

#letter ⇒ String

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

Returns:

  • (String) —

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



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

attribute :letter

#password ⇒ String?

Returns The password for C(username).

Returns:

  • (String, nil) —

    The password for C(username).



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

attribute :password

#path ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :path

#state ⇒ :absent, ...

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

Returns:

  • (:absent, :present, nil) —

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



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

attribute :state

#username ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :username