dellemc.powerstore.nfs_server (3.2.0) — module

Manage NFS server for PowerStore

| "added in version" 3.1.0 of dellemc.powerstore"

Authors: Trisha Datta (@trisha-dell) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

Managing storage containers on PowerStore Storage System includes creating an NFS server, getting details of an NFS server, modifying an NFS server and deleting an NFS server.


Requirements

Usage examples

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

- name: Enable NFS server
  register: result
  dellemc.powerstore.nfs_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ nas_server_name }}"
    host_name: "sample.hostname"
    is_nfsv3_enabled: true
    is_nfsv4_enabled: true
    is_secure_enabled: false
    is_extended_credentials_enabled: false
    credentials_cache_TTL: 60
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get NFS server
  dellemc.powerstore.nfs_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nfs_server_id: "{{ result.nfs_server_details.id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get NFS server with NAS server
  dellemc.powerstore.nfs_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ result.nfs_server_details.nas_server_id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify NFS server
  dellemc.powerstore.nfs_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nfs_server_id: "{{ result.nfs_server_details.id }}"
    is_nfsv4_enabled: false
    is_extended_credentials_enabled: true
    credentials_cache_TTL: 120
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete NFS server
  dellemc.powerstore.nfs_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nfs_server_id: "{{ result.nfs_server_details.id }}"
    state: "absent"

Inputs

    
port:
    description:
    - Port number for the PowerStore array.
    - If not passed, it will take 443 as default.
    type: int

user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the NFS server should be enabled or not.
    - For Delete operation only, it should be set to C(absent).
    type: str

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

host_name:
    description:
    - The name that will be used by NFS clients to connect to this NFS server.
    type: str

nas_server:
    description:
    - Unique identifier/name of the NAS server to which the network interface belongs,
      as defined by the I(nas_server) resource type.
    type: str

nfs_server_id:
    description:
    - The unique identifier of the NFS server.
    type: str

is_skip_unjoin:
    description:
    - Allow to bypass NFS server unjoin.
    - If false modification will fail if secure is enabled and current kdc_type is MS
      Windows.
    - If secure is enabled either unjoin NFS server before deleting or set value to true.
    type: bool

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - C(false) - indicates that the SSL certificate should not be verified.
    type: bool

is_nfsv3_enabled:
    description:
    - Indicates whether NFSv3 is enabled on the NAS server.
    type: bool

is_nfsv4_enabled:
    description:
    - Indicates whether NFSv4 is enabled on the NAS server.
    type: bool

is_secure_enabled:
    description:
    - Indicates whether secure NFS is enabled on the NFS server.
    type: bool

credentials_cache_TTL:
    description:
    - Sets the Time-To-Live (in minutes) expiration time in minutes for a Windows entry
      in the credentials cache.
    type: int

is_use_smb_config_enabled:
    description:
    - Indicates whether SMB authentication is used to authenticate to the KDC.
    type: bool

is_extended_credentials_enabled:
    description:
    - Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential.
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
nfs_server_details:
  contains:
    credentials_cache_TTL:
      description: Sets the Time-To-Live (in minutes) expiration timestamp for a Windows
        entry in the credentials cache.
      type: int
    host_name:
      description: The name that will be used by NFS clients to connect to this NFS
        server.
      type: str
    id:
      description: The unique identifier of the NFS server.
      type: str
    is_extended_credentials_enabled:
      description: Indicates whether the NFS server supports more than 16 Unix groups
        in a Unix credential.
      type: bool
    is_joined:
      description: Indicates whether the NFS server is joined to Active Directory.
      type: bool
    is_nfsv3_enabled:
      description: Indicates whether NFSv3 is enabled on the NAS server.
      type: bool
    is_nfsv4_enabled:
      description: Indicates whether NFSv4 is enabled on the NAS server.
      type: bool
    is_secure_enabled:
      description: Indicates whether secure NFS is enabled on the NFS server.
      type: bool
    is_use_smb_config_enabled:
      description: Indicates whether SMB authentication is used to authenticate to
        the KDC.
      type: bool
    nas_server_id:
      description: Unique identifier of the NAS server.
      type: str
    service_principal_name:
      description: The Service Principal Name (SPN) for the NFS server.
      type: str
  description: Details of the NFS server.
  returned: When NFS server is enabled.
  sample:
    credentials_cache_TTL: 120
    host_name: sample_host_name
    id: 65ad14fe-5f6e-beb3-424f-62b767ad9845
    is_extended_credentials_enabled: true
    is_joined: false
    is_nfsv3_enabled: true
    is_nfsv4_enabled: false
    is_secure_enabled: false
    is_use_smb_config_enabled: null
    nas_server_id: 6581683c-61a3-76ab-f107-62b767ad9845
    service_principal_name: null
  type: complex