dellemc.powerscale.nfs_zone_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 zone settings on an PowerScale system includes retrieving details and modifying NFS zone 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 zone settings
  dellemc.powerscale.nfs_zone_settings:
    onefs_host: "{{onefs_host}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    verify_ssl: "{{verify_ssl}}"
    access_zone: "sample-zone"

Scanned by Steampunk Spotter

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

- name: Modify NFS zone settings
  dellemc.powerscale.nfs_zone_settings:
    onefs_host: "{{onefs_host}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    verify_ssl: "{{verify_ssl}}"
    access_zone: "sample-zone"
    nfsv4_allow_numeric_ids: true
    nfsv4_domain: "example.com"
    nfsv4_no_domain: true
    nfsv4_no_domain_uids: false

Inputs

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

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

access_zone:
    default: System
    description:
    - Specifies the access zone in which the NFS zone settings apply.
    type: str

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

nfsv4_domain:
    description:
    - Specifies the domain through which users and groups are associated.
    type: str

nfsv4_no_names:
    description:
    - If C(true), sends owners and groups as UIDs and GIDs.
    type: bool

nfsv4_no_domain:
    description:
    - If C(true), sends owners and groups without a domain name.
    type: bool

nfsv4_no_domain_uids:
    description:
    - If C(true), sends UIDs and GIDs without a domain name.
    type: bool

nfsv4_replace_domain:
    description:
    - If C(true), replaces the owner or group domain with an NFS domain name.
    type: bool

nfsv4_allow_numeric_ids:
    description:
    - If C(true), send owner and groups as UIDs and GIDs when look up fails or I(nfsv4_no_names)
      is set C(rue).
    type: bool

Outputs

changed:
  description: A boolean indicating if the task had to make changes.
  returned: always
  sample: 'false'
  type: bool
nfs_zone_settings_details:
  contains:
    nfsv4_allow_numeric_ids:
      description: If C(true), sends owners and groups as UIDs and GIDs when look
        up fails or if the I(nfsv4_no_names) property is set to 1.
      type: bool
    nfsv4_domain:
      description: Specifies the domain through which users and groups are associated.
      type: str
    nfsv4_no_domain:
      description: If C(true), sends owners and groups without a domain name.
      type: bool
    nfsv4_no_domain_uids:
      description: If C(true), sends UIDs and GIDs without a domain name.
      type: bool
    nfsv4_no_names:
      description: If C(true), sends owners and groups as UIDs and GIDs.
      type: bool
    nfsv4_replace_domain:
      description: If C(true), replaces the owner or group domain with an NFS domain
        name.
      type: bool
    zone:
      description: Specifies the access zone in which the NFS zone settings apply.
      type: str
  description: The NFS zone settings details.
  returned: always
  sample:
    nfsv4_allow_numeric_ids: false
    nfsv4_domain: ''
    nfsv4_no_domain: false
    nfsv4_no_domain_uids: false
    nfsv4_no_names: false
    nfsv4_replace_domain: false
    zone: System
  type: dict