dellemc.powerscale.nfs_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 NFS global settings on an PowerScale system includes retrieving details of NFS global settings and modifying NFS 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 NFS global settings
  dellemc.powerscale.nfs_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 service of NFS global settings
  dellemc.powerscale.nfs_global_settings:
    onefs_host: "{{ onefs_host }}"
    port_no: "{{ port_no }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    service: true
    nfsv3:
      nfsv3_enabled: false
    nfsv4:
      nfsv40_enabled: true
      nfsv41_enabled: true
      nfsv42_enabled: false
    rpc_minthreads: 17
    rpc_maxthreads: 20
    rquota_enabled: true

Inputs

    
nfsv3:
    description:
    - Enable/disable NFSv3 protocol.
    suboptions:
      nfsv3_enabled:
        description:
        - Enable/disable NFSv3 protocol.
        type: bool
      nfsv3_rdma_enabled:
        description:
        - To enable/disable RDMA for NFSv3 protocol.
        type: bool
    type: dict

nfsv4:
    description:
    - Specifies the minor versions of NFSv4 protocol.
    suboptions:
      nfsv40_enabled:
        description:
        - Enable/disable minor version 0 of NFSv4 protocol.
        type: bool
      nfsv41_enabled:
        description:
        - Enable/disable minor version 1 of NFSv4 protocol.
        type: bool
      nfsv42_enabled:
        description:
        - Enable/disable minor version 2 of NFSv4 protocol.
        type: bool
      nfsv4_enabled:
        description:
        - Enable/disable all minor versions of NFSv4 protocol.
        type: bool
    type: dict

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

service:
    description:
    - Specifies if the NFS service needs to be enabled or not.
    type: bool

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

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

rpc_maxthreads:
    description:
    - Specifies the maximum number of threads in the nfsd thread pool.
    type: int

rpc_minthreads:
    description:
    - Specifies the minimum number of threads in the nfsd thread pool.
    type: int

rquota_enabled:
    description:
    - Enable/Disable the rquota protocol.
    type: bool

Outputs

changed:
  description: A boolean indicating if the task had to make changes.
  returned: always
  sample: 'false'
  type: bool
nfs_global_settings_details:
  contains:
    nfsv3_enabled:
      description: Whether NFSv3 protocol is enabled/disabled.
      type: bool
    nfsv3_rdma_enabled:
      description: Whether rdma is enabled for NFSv3 protocol.
      type: bool
    nfsv40_enabled:
      description: Whether version 0 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv41_enabled:
      description: Whether version 1 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv42_enabled:
      description: Whether version 2 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv4_enabled:
      description: Whether NFSv4 protocol is enabled/disabled.
      type: bool
    rpc_maxthreads:
      description: Specifies the maximum number of threads in the nfsd thread pool.
      type: int
    rpc_minhreads:
      description: Specifies the minimum number of threads in the nfsd thread pool.
      type: int
    rquota_enabled:
      description: Whether the rquota protocol is enabled/disabled.
      type: bool
    service:
      description: Whether the NFS service is enabled/disabled.
      type: bool
  description: The updated nfs global settings details.
  returned: always
  sample:
    nfsv3_enabled: false
    nfsv3_rdma_enabled: true
    nfsv40_enabled: true
    nfsv41_enabled: true
    nfsv42_enabled: false
    nfsv4_enabled: true
    rpc_maxthreads: 20
    rpc_minthreads: 17
    rquota_enabled: true
    service: true
  type: complex