dellemc.powerscale.smb_global_settings (3.0.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 3.0.0

Description

Managing SMB global settings on a PowerScale system includes retrieving details of SMB global settings and modifying SMB global settings.

Requirements

• A Dell PowerScale Storage system.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get SMB global settings
  dellemc.powerscale.smb_global_settings:
    onefs_host: "{{ onefs_host }}"
    port_no: "{{ port_no }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update SMB global settings
  dellemc.powerscale.smb_global_settings:
    onefs_host: "{{ onefs_host }}"
    port_no: "{{ port_no }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    access_based_share_enum: true
    dot_snap_accessible_child: true
    dot_snap_accessible_root: false
    dot_snap_visible_child: false
    dot_snap_visible_root: true
    enable_security_signatures: true
    guest_user: user
    ignore_eas: false
    onefs_cpu_multiplier: 2
    onefs_num_workers: 4
    reject_unencrypted_access: true
    require_security_signatures: true
    server_side_copy: true
    server_string: 'PowerScale Server'
    service: true
    support_multichannel: true
    support_netbios: true
    support_smb2: true
    support_smb3_encryption: true

Inputs

    
port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

service:
    description: Specify whether service is enabled.
    type: bool

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

guest_user:
    description: Specifies the fully-qualified user to use for guest access.
    type: str

ignore_eas:
    description: Specify whether to ignore EAs on files.
    type: bool

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified.
    - C(false) - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

support_smb2:
    description: The support SMB2 attribute.
    type: bool

server_string:
    description: Provides a description of the server.
    type: str

support_netbios:
    description: Support NetBIOS.
    type: bool

server_side_copy:
    description: Enable Server Side Copy.
    type: bool

onefs_num_workers:
    description: Set the maximum number of OneFS driver worker threads.
    type: int

onefs_cpu_multiplier:
    description: Specify the number of OneFS driver worker threads per CPU.
    type: int

support_multichannel:
    description: Support multichannel.
    type: bool

dot_snap_visible_root:
    description: Show the .snapshot directory in the root of a share.
    type: bool

dot_snap_visible_child:
    description: Show .snapshot directories in share subdirectories.
    type: bool

access_based_share_enum:
    description: Only enumerate files and folders the requesting user has access to.
    type: bool

support_smb3_encryption:
    description: Support the SMB3 encryption on the server.
    type: bool

dot_snap_accessible_root:
    description: Allow access to the .snapshot directory in the root of the share.
    type: bool

dot_snap_accessible_child:
    description: Allow access to .snapshot directories in share subdirectories.
    type: bool

reject_unencrypted_access:
    description: If SMB3 encryption is enabled, reject unencrypted access from clients.
    type: bool

enable_security_signatures:
    description: Indicates whether the server supports signed SMB packets.
    type: bool

require_security_signatures:
    description: Indicates whether the server requires signed SMB packets.
    type: bool

Outputs

changed:
  description: A boolean indicating if the task had to make changes.
  returned: always
  sample: 'false'
  type: bool
smb_global_settings_details:
  contains:
    access_based_share_enum:
      description: Only enumerate files and folders the requesting user has access
        to.
      type: bool
    audit_fileshare:
      description: Specify level of file share audit events to log.
      type: str
    audit_logon:
      description: Specify the level of logon audit events to log.
      type: str
    dot_snap_accessible_child:
      description: Allow access to .snapshot directories in share subdirectories.
      type: bool
    dot_snap_accessible_root:
      description: Allow access to the .snapshot directory in the root of the share.
      type: bool
    dot_snap_visible_child:
      description: Show .snapshot directories in share subdirectories.
      type: bool
    dot_snap_visible_root:
      description: Show the .snapshot directory in the root of a share.
      type: bool
    enable_security_signatures:
      description: Indicates whether the server supports signed SMB packets.
      type: bool
    guest_user:
      description: Specifies the fully-qualified user to use for guest access.
      type: str
    ignore_eas:
      description: Specify whether to ignore EAs on files.
      type: bool
    onefs_cpu_multiplier:
      description: Specify the number of OneFS driver worker threads per CPU.
      type: int
    onefs_num_workers:
      description: Set the maximum number of OneFS driver worker threads.
      type: int
    reject_unencrypted_access:
      description: If SMB3 encryption is enabled, reject unencrypted access from clients.
      type: bool
    require_security_signatures:
      description: Indicates whether the server requires signed SMB packets.
      type: bool
    server_side_copy:
      description: Enable Server Side Copy.
      type: bool
    server_string:
      description: Provides a description of the server.
      type: str
    service:
      description: Specify whether service is enabled.
      type: bool
    srv_cpu_multiplier:
      description: Specify the number of SRV service worker threads per CPU.
      type: int
    srv_num_workers:
      description: Set the maximum number of SRV service worker threads.
      type: int
    support_multichannel:
      description: Support multichannel.
      type: bool
    support_netbios:
      description: Support NetBIOS.
      type: bool
    support_smb2:
      description: The support SMB2 attribute.
      type: bool
    support_smb3_encryption:
      description: Support the SMB3 encryption on the server.
      type: bool
  description: The updated SMB global settings details.
  returned: always
  sample:
    access_based_share_enum: false
    audit_fileshare: null
    audit_logon: null
    dot_snap_accessible_child: true
    dot_snap_accessible_root: true
    dot_snap_visible_child: false
    dot_snap_visible_root: true
    enable_security_signatures: false
    guest_user: nobody
    ignore_eas: false
    onefs_cpu_multiplier: 4
    onefs_num_workers: 0
    reject_unencrypted_access: false
    require_security_signatures: false
    server_side_copy: false
    server_string: PowerScale Server
    service: true
    srv_cpu_multiplier: null
    srv_num_workers: null
    support_multichannel: true
    support_netbios: false
    support_smb2: true
    support_smb3_encryption: true
  type: dict