Class: Ansible::Ruby::Modules::Udm_share

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb

Overview

This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

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

#directorymode ⇒ String?

Returns Permissions for the share's root directory.

Returns:

  • (String, nil) —

    Permissions for the share's root directory.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 43

attribute :directorymode

#group ⇒ String?

Returns Directory owner group of the share's root directory.

Returns:

  • (String, nil) —

    Directory owner group of the share's root directory.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 39

attribute :group

#host ⇒ String?

Returns Host FQDN (server which provides the share), e.g. C(ansible_fqdn }). Required if C(state=present).

Returns:

  • (String, nil) —

    Host FQDN (server which provides the share), e.g. C(ansible_fqdn }). Required if C(state=present).



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 20

attribute :host

#name ⇒ String

Returns Name.

Returns:

  • (String) —

    Name



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 16

attribute :name

#nfs_custom_settings ⇒ Object?

Returns Option name in exports file.

Returns:

  • (Object, nil) —

    Option name in exports file.



205
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 205

attribute :nfs_custom_settings

#nfs_hosts ⇒ Object?

Returns Only allow access for this host, IP address or network.

Returns:

  • (Object, nil) —

    Only allow access for this host, IP address or network.



202
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 202

attribute :nfs_hosts

#ou ⇒ Object

Returns Organisational unit, inside the LDAP Base DN.

Returns:

  • (Object) —

    Organisational unit, inside the LDAP Base DN.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 31

attribute :ou

#owner ⇒ Integer?

Returns Directory owner of the share's root directory.

Returns:

  • (Integer, nil) —

    Directory owner of the share's root directory.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 35

attribute :owner

#path ⇒ String?

Returns Directory on the providing server, e.g. C(/home). Required if C(state=present).

Returns:

  • (String, nil) —

    Directory on the providing server, e.g. C(/home). Required if C(state=present).



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 24

attribute :path

#root_squash ⇒ 0, ...

Returns Modify user ID for root user (root squashing).

Returns:

  • (0, 1, nil) —

    Modify user ID for root user (root squashing).



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 47

attribute :root_squash

#samba_block_size ⇒ Object?

Returns Blocking size.

Returns:

  • (Object, nil) —

    Blocking size.



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 63

attribute :samba_block_size

#samba_blocking_locks ⇒ 0, ...

Returns Blocking locks.

Returns:

  • (0, 1, nil) —

    Blocking locks.



66
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 66

attribute :samba_blocking_locks

#samba_browseable ⇒ 0, ...

Returns Show in Windows network environment.

Returns:

  • (0, 1, nil) —

    Show in Windows network environment.



70
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 70

attribute :samba_browseable

#samba_create_mode ⇒ String?

Returns File mode.

Returns:

  • (String, nil) —

    File mode.



74
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 74

attribute :samba_create_mode

#samba_csc_policy ⇒ String?

Returns Client-side caching policy.

Returns:

  • (String, nil) —

    Client-side caching policy.



78
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 78

attribute :samba_csc_policy

#samba_custom_settings ⇒ Object?

Returns Option name in smb.conf and its value.

Returns:

  • (Object, nil) —

    Option name in smb.conf and its value.



82
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 82

attribute :samba_custom_settings

#samba_directory_mode ⇒ String?

Returns Directory mode.

Returns:

  • (String, nil) —

    Directory mode.



85
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 85

attribute :samba_directory_mode

#samba_directory_security_mode ⇒ String?

Returns Directory security mode.

Returns:

  • (String, nil) —

    Directory security mode.



89
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 89

attribute :samba_directory_security_mode

#samba_dos_filemode ⇒ 0, ...

Returns Users with write access may modify permissions.

Returns:

  • (0, 1, nil) —

    Users with write access may modify permissions.



93
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 93

attribute :samba_dos_filemode

#samba_fake_oplocks ⇒ 0, ...

Returns Fake oplocks.

Returns:

  • (0, 1, nil) —

    Fake oplocks.



97
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 97

attribute :samba_fake_oplocks

#samba_force_create_mode ⇒ 0, ...

Returns Force file mode.

Returns:

  • (0, 1, nil) —

    Force file mode.



101
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 101

attribute :samba_force_create_mode

#samba_force_directory_mode ⇒ 0, ...

Returns Force directory mode.

Returns:

  • (0, 1, nil) —

    Force directory mode.



105
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 105

attribute :samba_force_directory_mode

#samba_force_directory_security_mode ⇒ 0, ...

Returns Force directory security mode.

Returns:

  • (0, 1, nil) —

    Force directory security mode.



109
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 109

attribute :samba_force_directory_security_mode

#samba_force_group ⇒ Object?

Returns Force group.

Returns:

  • (Object, nil) —

    Force group.



113
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 113

attribute :samba_force_group

#samba_force_security_mode ⇒ 0, ...

Returns Force security mode.

Returns:

  • (0, 1, nil) —

    Force security mode.



116
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 116

attribute :samba_force_security_mode

#samba_force_user ⇒ Object?

Returns Force user.

Returns:

  • (Object, nil) —

    Force user.



120
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 120

attribute :samba_force_user

#samba_hide_files ⇒ Object?

Returns Hide files.

Returns:

  • (Object, nil) —

    Hide files.



123
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 123

attribute :samba_hide_files

#samba_hide_unreadable ⇒ 0, ...

Returns Hide unreadable files/directories.

Returns:

  • (0, 1, nil) —

    Hide unreadable files/directories.



126
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 126

attribute :samba_hide_unreadable

#samba_hosts_allow ⇒ Object?

Returns Allowed host/network.

Returns:

  • (Object, nil) —

    Allowed host/network.



130
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 130

attribute :samba_hosts_allow

#samba_hosts_deny ⇒ Object?

Returns Denied host/network.

Returns:

  • (Object, nil) —

    Denied host/network.



133
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 133

attribute :samba_hosts_deny

#samba_inherit_acls ⇒ 0, ...

Returns Inherit ACLs.

Returns:

  • (0, 1, nil) —

    Inherit ACLs.



136
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 136

attribute :samba_inherit_acls

#samba_inherit_owner ⇒ 0, ...

Returns Create files/directories with the owner of the parent directory.

Returns:

  • (0, 1, nil) —

    Create files/directories with the owner of the parent directory.



140
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 140

attribute :samba_inherit_owner

#samba_inherit_permissions ⇒ 0, ...

Returns Create files/directories with permissions of the parent directory.

Returns:

  • (0, 1, nil) —

    Create files/directories with permissions of the parent directory.



144
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 144

attribute :samba_inherit_permissions

#samba_invalid_users ⇒ Object?

Returns Invalid users or groups.

Returns:

  • (Object, nil) —

    Invalid users or groups.



148
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 148

attribute :samba_invalid_users

#samba_level_2_oplocks ⇒ 0, ...

Returns Level 2 oplocks.

Returns:

  • (0, 1, nil) —

    Level 2 oplocks.



151
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 151

attribute :samba_level_2_oplocks

#samba_locking ⇒ 0, ...

Returns Locking.

Returns:

  • (0, 1, nil) —

    Locking.



155
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 155

attribute :samba_locking

#samba_msdfs_root ⇒ 0, ...

Returns MSDFS root.

Returns:

  • (0, 1, nil) —

    MSDFS root.



159
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 159

attribute :samba_msdfs_root

#samba_name ⇒ Object?

Returns Windows name. Required if C(state=present).

Returns:

  • (Object, nil) —

    Windows name. Required if C(state=present).



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 28

attribute :samba_name

#samba_nt_acl_support ⇒ 0, ...

Returns NT ACL support.

Returns:

  • (0, 1, nil) —

    NT ACL support.



163
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 163

attribute :samba_nt_acl_support

#samba_oplocks ⇒ 0, ...

Returns Oplocks.

Returns:

  • (0, 1, nil) —

    Oplocks.



167
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 167

attribute :samba_oplocks

#samba_postexec ⇒ Object?

Returns Postexec script.

Returns:

  • (Object, nil) —

    Postexec script.



171
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 171

attribute :samba_postexec

#samba_preexec ⇒ Object?

Returns Preexec script.

Returns:

  • (Object, nil) —

    Preexec script.



174
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 174

attribute :samba_preexec

#samba_public ⇒ 0, ...

Returns Allow anonymous read-only access with a guest user.

Returns:

  • (0, 1, nil) —

    Allow anonymous read-only access with a guest user.



177
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 177

attribute :samba_public

#samba_security_mode ⇒ String?

Returns Security mode.

Returns:

  • (String, nil) —

    Security mode.



181
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 181

attribute :samba_security_mode

#samba_strict_locking ⇒ String?

Returns Strict locking.

Returns:

  • (String, nil) —

    Strict locking.



185
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 185

attribute :samba_strict_locking

#samba_valid_users ⇒ Object?

Returns Valid users or groups.

Returns:

  • (Object, nil) —

    Valid users or groups.



192
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 192

attribute :samba_valid_users

#samba_vfs_objects ⇒ Object?

Returns VFS objects.

Returns:

  • (Object, nil) —

    VFS objects.



189
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 189

attribute :samba_vfs_objects

#samba_write_list ⇒ Object?

Returns Restrict write access to these users/groups.

Returns:

  • (Object, nil) —

    Restrict write access to these users/groups.



195
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 195

attribute :samba_write_list

#samba_writeable ⇒ 0, ...

Returns Samba write access.

Returns:

  • (0, 1, nil) —

    Samba write access.



198
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 198

attribute :samba_writeable

#state ⇒ :present, ...

Returns Whether the share is present or not.

Returns:

  • (:present, :absent, nil) —

    Whether the share is present or not.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 12

attribute :state

#subtree_checking ⇒ 0, ...

Returns Subtree checking.

Returns:

  • (0, 1, nil) —

    Subtree checking.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 51

attribute :subtree_checking

#sync ⇒ String?

Returns NFS synchronisation.

Returns:

  • (String, nil) —

    NFS synchronisation.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 55

attribute :sync

#writeable ⇒ 0, ...

Returns NFS write access.

Returns:

  • (0, 1, nil) —

    NFS write access.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_share.rb', line 59

attribute :writeable