dellemc.unity.dellemc_unity_nasserver (1.2.1) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 1.2.1

Description

Managing NAS servers on Unity storage system includes get, modification to the NAS servers.

Requirements

• A DellEMC Unity Storage device.
• Ansible 2.9 or higher.

Usage examples

Scanned by Steampunk Spotter

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

    - name: Get Details of NAS Server
      dellemc.unity.dellemc_unity_nasserver:
        unispherehost: "{{unispherehost}}"
        username: "{{username}}"
        password: "{{password}}"
        verifycert: "{{verifycert}}"
        nas_server_name: "{{nas_server_name}}"
        state: "present"

Scanned by Steampunk Spotter

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

    - name: Modify Details of NAS Server
      dellemc.unity.dellemc_unity_nasserver:
        unispherehost: "{{unispherehost}}"
        username: "{{username}}"
        password: "{{password}}"
        verifycert: "{{verifycert}}"
        nas_server_name: "{{nas_server_name}}"
        nas_server_new_name: "updated_sample_nas_server"
        is_replication_destination: False
        is_backup_only: False
        is_multiprotocol_enabled: True
        allow_unmapped_user: True
        default_unix_user: "default_unix_sample_user"
        default_windows_user: "default_windows_sample_user"
        enable_windows_to_unix_username_mapping: True
        current_unix_directory_service: "LDAP"
        is_packet_reflect_enabled: True
        state: "present"

Inputs

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

state:
    choices:
    - present
    - absent
    description:
    - Define the state of NAS server on the array.
    - present indicates that NAS server should exist on the system after the task is executed.
    - Right now deletion of NAS server is not supported. Hence, if state is set to absent
      for any existing NAS server then error will be thrown.
    - For any non-existing NAS server, if state is set to absent then it will return None.
    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

verifycert:
    choices:
    - true
    - false
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - True - Indicates that the SSL certificate should be verified.
    - False - Indicates that the SSL certificate should not be verified.
    required: false
    type: bool

nas_server_id:
    description:
    - The ID of the NAS server.
    - nas_server_name and nas_server_id are mutually exclusive parameters.
    - Either one is required to perform the task.
    type: str

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

is_backup_only:
    description:
    - It specifies whether the NAS server is used as backup only.
    - It can be mentioned during modification of the NAS server.
    type: bool

nas_server_name:
    description:
    - The Name of the NAS server.
    - nas_server_name and nas_server_id are mutually exclusive parameters.
    - Either one  is required to perform the task.
    type: str

default_unix_user:
    description:
    - Default Unix user name used for granting access in the case of Windows to Unix user
      mapping failure.
    - It can be mentioned during modification of the NAS server.
    type: str

allow_unmapped_user:
    description:
    - This flag is used to mandatorily disable access in case of any user mapping failure.
    - If true, then enable access in case of any user mapping failure.
    - If false, then disable access in case of any user mapping failure.
    - It can be mentioned during modification of the NAS server.
    type: bool

nas_server_new_name:
    description:
    - The new name of the NAS server.
    - It can be mentioned during modification of the NAS server.
    type: str

default_windows_user:
    description:
    - Default windows user name used for granting access in the case of Unix to Windows
      user mapping failure.
    - It can be mentioned during modification of the NAS server.
    type: str

is_multiprotocol_enabled:
    description:
    - This parameter indicates whether multiprotocol sharing mode is enabled.
    - It can be mentioned during modification of the NAS server.
    type: bool

is_packet_reflect_enabled:
    description:
    - If the packet has to be reflected, then this parameter has to be set to True.
    - It can be mentioned during modification of the NAS server.
    type: bool

is_replication_destination:
    description:
    - It specifies whether the NAS server is a replication destination.
    - It can be mentioned during modification of the NAS server.
    type: bool

current_unix_directory_service:
    choices:
    - NONE
    - NIS
    - LOCAL
    - LDAP
    - LOCAL_THEN_NIS
    - LOCAL_THEN_LDAP
    description:
    - This is the directory service used for querying identity information for UNIX (such
      as UIDs, GIDs, net groups).
    - It can be mentioned during modification of the NAS server.
    type: str

enable_windows_to_unix_username_mapping:
    description:
    - This parameter indicates whether a Unix to/from Windows user name mapping is enabled.
    - It can be mentioned during modification of the NAS server.
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  sample: true
  type: bool
nas_server_details:
  contains:
    allow_unmapped_user:
      description: enable/disable access status in case of any user mapping failure
      type: bool
    current_unix_directory_service:
      description: Directory service used for querying identity information for UNIX
        (such as UIDs, GIDs, net groups).
      type: str
    default_unix_user:
      description: Default Unix user name used for granting access in the case of
        Windows to Unix user mapping failure.
      type: str
    default_windows_user:
      description: Default windows user name used for granting access in the case
        of Unix to Windows user mapping failure
      type: str
    id:
      description: ID of the NAS server
      type: str
    is_backup_only:
      description: Whether the NAS server is used as backup only.
      type: bool
    is_multi_protocol_enabled:
      description: Indicates whether multiprotocol sharing mode is enabled
      type: bool
    is_packet_reflect_enabled:
      description: If the packet reflect has to be enabled
      type: bool
    is_replication_destination:
      description: If the NAS server is a replication destination then True.
      type: bool
    is_windows_to_unix_username_mapping_enabled:
      description: Indicates whether a Unix to/from Windows user name mapping is enabled.
      type: bool
    name:
      description: Name of the NAS server
      type: str
  description: The NAS server details.
  returned: When NAS server exists.
  type: complex