dellemc.unity.nfsserver (2.0.0) — module

Manage NFS server on Unity storage system

| "added in version" 1.4.0 of dellemc.unity"

Authors: Meenakshi Dembi (@dembim) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0


Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing the NFS server on the Unity storage system includes creating NFS server, getting NFS server details and deleting NFS server attributes.


Requirements

Usage examples

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

- name: Create NFS server with kdctype as Windows
  dellemc.unity.nfsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    host_name: "dummy_nas23"
    is_secure_enabled: true
    kerberos_domain_controller_type: "WINDOWS"
    kerberos_domain_controller_username: "administrator"
    kerberos_domain_controller_password: "Password123!"
    is_extended_credentials_enabled: true
    nfs_v4_enabled: true
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create NFS server with kdctype as Unix
  dellemc.unity.nfsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    host_name: "dummy_nas23"
    is_secure_enabled: true
    kerberos_domain_controller_type: "UNIX"
    is_extended_credentials_enabled: true
    nfs_v4_enabled: true
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get NFS server details
  dellemc.unity.nfsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete NFS server
  dellemc.unity.nfsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    kerberos_domain_controller_username: "administrator"
    kerberos_domain_controller_password: "Password123!"
    unjoin_server_account: false
    state: "absent"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

state:
    choices:
    - absent
    - present
    description:
    - Define whether the NFS server should exist or not.
    required: true
    type: str

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

host_name:
    description:
    - Host name of the NFS server.
    type: str

nas_server_id:
    description:
    - ID of the NAS server on which NFS server will be hosted.
    type: str

nfs_server_id:
    description:
    - ID of the NFS server.
    type: str

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

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

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

nas_server_name:
    description:
    - Name of the NAS server on which NFS server will be hosted.
    type: str

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

remove_spn_from_kerberos:
    default: true
    description:
    - Indicates whether to remove the SPN from Kerberos Domain Controller.
    type: bool

is_extended_credentials_enabled:
    description:
    - Indicates whether support for more than 16 unix groups in a Unix credential.
    type: bool

kerberos_domain_controller_type:
    choices:
    - CUSTOM
    - UNIX
    - WINDOWS
    description:
    - Type of Kerberos Domain Controller used for secure NFS service.
    type: str

kerberos_domain_controller_password:
    description:
    - Kerberos Domain Controller administrator password.
    type: str

kerberos_domain_controller_username:
    description:
    - Kerberos Domain Controller administrator username.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: true
  type: bool
nfs_server_details:
  contains:
    credentials_cache_ttl:
      description: Credential cache refresh timeout. Resolution is in minutes. Default
        value is 15 minutes.
      type: str
    existed:
      description: Indicates if NFS Server exists.
      type: bool
    host_name:
      description: Host name of the NFS server.
      type: str
    id:
      description: Unique identifier of the NFS Server instance.
      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_secure_enabled:
      description: Indicates whether secure NFS is enabled on the NFS server.
      type: bool
    kdc_type:
      description: Type of Kerberos Domain Controller used for secure NFS service.
      type: str
    nfs_v4_enabled:
      description: Indicates whether NFSv4 is enabled on the NAS server.
      type: bool
    servicee_principal_name:
      description: The Service Principal Name (SPN) for the NFS Server.
      type: str
  description: Details of the NFS server.
  returned: When NFS server exists
  sample:
    credentials_cache_ttl: 0:15:00
    existed: true
    file_interfaces:
      UnityFileInterfaceList:
      - UnityFileInterface:
          hash: 8778980109421
          id: if_37
    hash: 8778980109388
    host_name: dummy_nas23.pie.lab.emc.com
    id: nfs_51
    is_extended_credentials_enabled: true
    is_secure_enabled: true
    kdc_type: KdcTypeEnum.WINDOWS
    nas_server:
      UnityNasServer:
        hash: 8778980109412
    nfs_v4_enabled: true
    servicee_principal_name: null
  type: dict