Class: Ansible::Ruby::Modules::Win_share

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/windows/win_share.rb

Overview

Add, modify or remove Windows share and set share permissions.

Instance Method Summary

• #change ⇒ String^?

  Specify user list that should get read and write access on share, separated by comma.

• #deny ⇒ String^?

  Specify user list that should get no access, regardless of implied access on share, separated by comma.

• #description ⇒ String^?

  Share description.

• #full ⇒ String^?

  Specify user list that should get full access on share, separated by comma.

• #list ⇒ Boolean^?

  Specify whether to allow or deny file listing, in case user got no permission on share.

• #name ⇒ String

  Share name.

• #path ⇒ String

  Share directory.

• #read ⇒ String^?

  Specify user list that should get read access on share, separated by comma.

• #state ⇒ :present, ...

  Specify whether to add C(present) or remove C(absent) the specified share.

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

#change ⇒ String^?

Returns Specify user list that should get read and write access on share, separated by comma.

Returns:

• (String, nil) —

  Specify user list that should get read and write access on share, separated by comma.

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 35

attribute :change

#deny ⇒ String^?

Returns Specify user list that should get no access, regardless of implied access on share, separated by comma.

Returns:

• (String, nil) —

  Specify user list that should get no access, regardless of implied access on share, separated by comma.

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 43

attribute :deny

#description ⇒ String^?

Returns Share description.

Returns:

• (String, nil) —

  Share description

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

attribute :description

#full ⇒ String^?

Returns Specify user list that should get full access on share, separated by comma.

Returns:

• (String, nil) —

  Specify user list that should get full access on share, separated by comma.

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 39

attribute :full

#list ⇒ Boolean^?

Returns Specify whether to allow or deny file listing, in case user got no permission on share.

Returns:

• (Boolean, nil) —

  Specify whether to allow or deny file listing, in case user got no permission on share

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 27

attribute :list

#name ⇒ String

Returns Share name.

Returns:

• (String) —

  Share name

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 11

attribute :name

#path ⇒ String

Returns Share directory.

Returns:

• (String) —

  Share directory

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 15

attribute :path

#read ⇒ String^?

Returns Specify user list that should get read access on share, separated by comma.

Returns:

• (String, nil) —

  Specify user list that should get read access on share, separated by comma.

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 31

attribute :read

#state ⇒ :present, ...

Returns Specify whether to add C(present) or remove C(absent) the specified share.

Returns:

• (:present, :absent, nil) —

  Specify whether to add C(present) or remove C(absent) the specified share

# File 'lib/ansible/ruby/modules/generated/extras/windows/win_share.rb', line 19

attribute :state