dellemc.powerscale.dellemc_powerscale_ads (1.4.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==1.4.0

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 1.4.0

Description

Manages the Active Directory authentication provider on the PowerScale storage system. This includes creating, modifying, deleting and retreiving the details of an ADS provider.

Requirements

• A DellEMC PowerScale Storage system.
• Ansible 2.7 and above.

Usage examples

Scanned by Steampunk Spotter

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

- name: Add an Active Directory provider
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      domain_name: "ansibleneo.com"
      instance_name: "ansibleneo.com"
      ads_user: "administrator"
      ads_password: "*****"
      ads_parameters:
        groupnet: "groupnet5"
        home_directory_template: "/ifs/home/%D/%U"
        login_shell: "/bin/zsh"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Modify an Active Directory provider with domain name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      domain_name: "ansibleneo.com"
      ads_parameters:
        home_directory_template: "/ifs/usr_home/%D/%U"
        login_shell: "/bin/rbash"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Modify an Active Directory provider with instance name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      instance_name: "ansibleneo.com"
      ads_parameters:
        home_directory_template: "/ifs/usr_home/%D/%U"
        login_shell: "/bin/rbash"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Get Active Directory provider details with domain name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      domain_name: "ansibleneo.com"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Get Active Directory provider details with instance name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      instance_name: "ansibleneo.com"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Delete an Active Directory provider with domain name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      domain_name: "ansibleneo.com"
      state: "absent"

Scanned by Steampunk Spotter

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

- name: Delete an Active Directory provider with instance name
  dellemc_powerscale_ads:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      instance_name: "ansibleneo.com"
      state: "absent"

Inputs

    
state:
    choices:
    - absent
    - present
    description:
    - The state of the ads provider after the task is performed.
    - present - indicates that the ADS provider should exist on the system.
    - absent - indicates that the ADS provider should not exist on the system.
    required: true
    type: str

port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

ads_user:
    description:
    - Specifies the user name that has permission to join a machine to the given domain.
    - This parameter is mandatory during create.
    type: str

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

domain_name:
    description:
    - Specifies the domain name of an Active Directory provider.
    - This parameter is mandatory during create.
    type: str

ads_password:
    description:
    - Specifies the password used during domain join.
    - This parameter is mandatory during create.
    type: str

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

instance_name:
    description:
    - Specifies the instance name of Active Directory provider.
    - This is an optional parameter during create, and defaults to the provider name if
      it is not specified during the create operation.
    - get, modify and delete operations can also be performed through instance_name.
    - It is mutually exclusive with domain_name for get, modify and delete operations.
    type: str

ads_parameters:
    description:
    - Specify additional parameters to configure ADS domain.
    suboptions:
      groupnet:
        description:
        - Groupnet identifier.
        - This is an optional parameter and defaults to groupnet0.
        type: str
      home_directory_template:
        description:
        - Specifies the path to the home directory template.
        - This is an optional parameter and defaults to '/ifs/home/%D/%U'.
        type: str
      login_shell:
        choices:
        - /bin/sh
        - /bin/csh
        - /bin/tcsh
        - /bin/zsh
        - /bin/bash
        - /bin/rbash
        - /sbin/nologin
        description:
        - Specifies the login shell path.
        - This is an optional parameter and defaults to '/bin/zsh'.
        type: str
    type: dict

Outputs

ads_provider_details:
  contains:
    groupnet:
      description: Groupnet identifier.
      type: str
    home_directory_template:
      description: Specifies the path to the home directory template.
      type: str
    id:
      description: Specifies the ID of the Active Directory provider instance.
      type: str
    linked_access_zones:
      description: List of access zones linked to the authentication provider.
      type: list
    login_shell:
      description: Specifies the login shell path.
      type: str
    name:
      description: Specifies the Active Directory provider name.
      type: str
  description: The Active Directory provider details
  returned: When Active Directory provider exists
  type: complex
changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool