/ home / dellemc / dellemc.powerstore / 3.2.0 / module / file_dns

dellemc.powerstore.file_dns (3.2.0) — module

Manage File DNS 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 a file DNS, getting details of a file DNS, modifying a file DNS and deleting a file DNS.

Requirements

A Dell PowerStore storage system version 3.0.0.0 or later.
Ansible-core 2.14 or later.
PyPowerStore 3.1.0.
Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter


- name: Enable file DNS
  register: result
  dellemc.powerstore.file_dns:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ nas_server_name }}"
    domain: "NAS_domain"
    add_ip_addresses:
      - "10.**.**.**"
    transport: "UDP"
    state: "present"

Scanned by Steampunk Spotter

- name: Get File DNS
  dellemc.powerstore.file_dns:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    file_dns_id: "{{ result.file_dns_details.id }}"

Scanned by Steampunk Spotter

- name: Get File DNS with NAS server
  dellemc.powerstore.file_dns:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ result.file_dns_details.nas_server_id }}"

Scanned by Steampunk Spotter

- name: Modify File DNS
  dellemc.powerstore.file_dns:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    file_dns_id: "{{ result.file_dns_details.id }}"
    domain: "NAS_domain"
    add_ip_addresses:
      - "10.**.**.@@"
    remove_ip_addresses:
      - "10.**.**.**"
    transport: "UDP"

Scanned by Steampunk Spotter

- name: Delete file DNS
  dellemc.powerstore.file_dns:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    file_dns_id: "{{ result.file_dns_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 file DNS should be enabled or not.
    - For Delete operation only, it should be set to C(absent).
    type: str

domain:
    description:
    - Name of the DNS domain, where the NAS Server does host names lookup when an FQDN
      is not specified in the request.
    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

transport:
    choices:
    - UDP
    - TCP
    description:
    - Transport used when connecting to the DNS Server.
    - C(UDP) - DNS uses the UDP protocol.
    - C(TCP) - DNS uses the TCP protocol.
    type: str

nas_server:
    description:
    - Unique identifier/name of the associated NAS Server instance that uses this DNS
      Service object.
    type: str

file_dns_id:
    description:
    - The unique identifier of the file DNS.
    type: str

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

add_ip_addresses:
    description:
    - IP addresses to add to the current list.
    - IPv4 and IPv6 are supported.
    elements: str
    type: list

remove_ip_addresses:
    description:
    - IP addresses to remove from the current list.
    - IPv4 and IPv6 are supported.
    elements: str
    type: list

is_destination_override_enabled:
    description:
    - In order to modify any properties of this resource when the associated NAS server
      is a replication destination, the I(is_destination_override_enabled) flag must be
      set to C(true).
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
file_nis_details:
  contains:
    domain:
      description: Name of the DNS domain.
      type: str
    id:
      description: The unique identifier of the file DNS.
      type: str
    ip_addresses:
      description: The addresses may be IPv4 or IPv6.
      elements: str
      type: list
    is_destination_override_enabled:
      description: Used in replication context when the user wants to override the
        settings on the destination.
      type: bool
    nas_server_id:
      description: Unique identifier of the NAS server.
      type: str
    transport:
      description: Transport used when connecting to the DNS Server.
      type: str
  description: Details of the file DNS.
  returned: When file DNS exists.
  sample:
    domain: NAS_domain
    id: 65ab7e44-7009-e3e5-907a-62b767ad9845
    ip_addresses:
    - 10.**.**.**
    is_destination_override_enabled: false
    nas_server_id: 6581683c-61a3-76ab-f107-62b767ad9845
    transport: UDP
  type: complex