dellemc.powerstore.dellemc_powerstore_nasserver (1.3.0) — module

NAS Server operations on PowerStore Storage system.

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

Authors: Arindam Datta (@dattaarindam) <ansible.team@dell.com>

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Supports getting the details and modifying the attributes of a NAS server.


Requirements

Usage examples

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

 - name: Get details of NAS Server by name
   dellemc_powerstore_nasserver:
     array_ip: "{{array_ip}}"
     verifycert: "{{verifycert}}"
     user: "{{user}}"
     password: "{{password}}"
     nas_server_name: "{{nas_server_name}}"
     state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get Details of NAS Server by ID
   dellemc_powerstore_nasserver:
     array_ip: "{{array_ip}}"
     verifycert: "{{verifycert}}"
     user: "{{user}}"
     password: "{{password}}"
     nas_server_id: "{{nas_id}}"
     state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Rename NAS Server by Name
   dellemc_powerstore_nasserver:
     array_ip: "{{array_ip}}"
     verifycert: "{{verifycert}}"
     user: "{{user}}"
     password: "{{password}}"
     nas_server_name: "{{nas_server_name}}"
     nas_server_new_name : "{{nas_server_new_name}}"
     state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Modify NAS Server attributes by ID
   dellemc_powerstore_nasserver:
     array_ip: "{{array_ip}}"
     verifycert: "{{verifycert}}"
     user: "{{user}}"
     password: "{{password}}"
     nas_server_id: "{{nas_id}}"
     current_unix_directory_service: "LOCAL_FILES"
     current_node: "{{cur_node_n1}}"
     preferred_node: "{{prefered_node}}"
     state: "present"

Inputs

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

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

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

verifycert:
    choices:
    - true
    - false
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

description:
    description:
    - Description of the NAS server.
    type: str

current_node:
    description:
    - Unique identifier or name of the node on which the NAS server is running.
    type: str

nas_server_id:
    description:
    - Unique id of the NAS server. Mutually exclusive with nas_server_name.
    type: str

preferred_node:
    description:
    - Unique identifier or name of the preferred node for the NAS server. The initial
      value (on NAS server create) is taken from the current node.
    type: str

nas_server_name:
    description:
    - Name of the NAS server. Mutually exclusive with nas_server_id.
    type: str

default_unix_user:
    description:
    - Default Unix user name used for granting access in case of Windows to Unix user
      mapping failure. When empty, access in such case is denied.
    type: str

nas_server_new_name:
    description:
    - New name of the NAS server for a rename operation.
    type: str

default_windows_user:
    description:
    - Default Windows user name used for granting access in case of Unix to Windows user
      mapping failure. When empty, access in such case is denied.
    type: str

current_unix_directory_service:
    choices:
    - NIS
    - LDAP
    - LOCAL_FILES
    - LOCAL_THEN_NIS
    - LOCAL_THEN_LDAP
    description:
    - Define the Unix directory service used for looking up identity information for Unix
      such as UIDs, GIDs, net groups, and so on.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool
nasserver_details:
  contains:
    backup_IPv4_interface_id:
      description: Unique identifier of the preferred IPv4 backup interface.
      type: str
    backup_IPv6_interface_id:
      description: Unique identifier of the preferred IPv6 backup interface.
      type: str
    current_node:
      description: Unique identifier and name of the node on which the NAS server
        is running.
      type: dict
    current_unix_directory_service:
      description: Define the Unix directory service used for looking up identity
        information for Unix such as UIDs, GIDs, net groups, and so on.
      type: str
    default_unix_user:
      description: Default Unix user name used for granting access in case of Windows
        to Unix user mapping failure.
      type: str
    description:
      description: Additional information about the nas server.
      type: str
    file_interfaces:
      description: This is the inverse of the resource type file_interface association.
        Will return the id,name & ip_address of the associated file interface.
      type: dict
    file_ldaps:
      description: This is the inverse of the resource type file_ldap association.
      type: str
    file_systems:
      description: This is the inverse of the resource type file_system association.
      type: dict
    id:
      description: The system generated ID given to the nas server
      type: str
    is_username_translation_enabled:
      description: Enable the possibility to match a windows account to a Unix account
        with different names.
      type: bool
    name:
      description: Name of the nas server
      type: str
    nfs_servers:
      description: This is the inverse of the resource type nfs_server association.
      type: str
    operational_status:
      description: NAS server operational status.
      type: str
    preferred_node:
      description: Unique identifier and name of the preferred node for the NAS server.
      type: dict
    production_IPv4_interface_id:
      description: Unique identifier of the preferred IPv4 production interface.
      type: str
    production_IPv6_interface_id:
      description: Unique identifier of the preferred IPv6 production interface.
      type: str
    smb_servers:
      description: This is the inverse of the resource type smb_server association.
      type: str
  description: Details about the nas server
  returned: When nas server exists
  type: complex