dellemc.powerscale.user_mapping_rule (3.0.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 3.0.0

Description

Manages user mapping rules on PowerScale Storage System. This includes creating a new user mapping rule, modifying a user mapping rule, changing order of a user mapping rule, deleting a user mapping rule and retrieving the details of a user mapping rule.

Requirements

• A Dell PowerScale Storage system.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get a user mapping rule
  dellemc.powerscale.user_mapping_rule:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    apply_order: 1

Scanned by Steampunk Spotter

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

- name: Delete a user mapping rule
  dellemc.powerscale.user_mapping_rule:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    apply_order: 1
    state: 'absent'

Scanned by Steampunk Spotter

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

- name: Create a user mapping rule
  dellemc.powerscale.user_mapping_rule:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    rule:
    operator: "insert"
    options:
      break: false
      group: true
      groups: true
      user: true
    user1:
      domain: "ansibleneo.com"
      user: "test_user"
    user2:
      user: "ans_user"
    state: 'present'

Scanned by Steampunk Spotter

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

- name: Update a user mapping rule
  dellemc.powerscale.user_mapping_rule:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    apply_order: 1
    rule:
    options:
      break: true
    state: 'present'

Scanned by Steampunk Spotter

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

- name: Apply a new order to the user mapping rule
  dellemc.powerscale.user_mapping_rule:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    apply_order: 1
    new_order: 2

Inputs

    
rule:
    description: The user mapping rule.
    suboptions:
      operator:
        choices:
        - insert
        - append
        - union
        - replace
        - trim
        description:
        - The operation that a rule carries out.
        type: str
      options:
        description:
        - Specifies the properties for user mapping rules.
        suboptions:
          break_on_match:
            description:
            - If C(true), and the rule was applied successfuly, stop processing further.
            type: bool
          default_user:
            description:
            - If the mapping service fails to find the second user in a rule, the service
              tries to find the username of the default user.
            suboptions:
              domain:
                description: The name of domain.
                type: str
              user:
                description: The username of the user.
                required: true
                type: str
            type: dict
          group:
            description:
            - If C(true), the primary GID and primary group SID should be copied to the
              existing credential.
            type: bool
          groups:
            description:
            - If C(true), all additional identifiers should be copied to the existing
              credential.
            type: bool
          user:
            description:
            - If C(true), the primary UID and primary user SID should be copied to the
              existing credential.
            type: bool
        type: dict
      user1:
        description:
        - A UNIX user or an Active Directory user.
        - The user for which the identifier changes are applied.
        suboptions:
          domain:
            description: The name of domain.
            type: str
          user:
            description: The username of the user.
            required: true
            type: str
        type: dict
      user2:
        description:
        - A UNIX user or an Active Directory user.
        - The user from which the identifier are taken.
        suboptions:
          domain:
            description: The name of domain.
            type: str
          user:
            description: The username of the user.
            required: true
            type: str
        type: dict
    type: dict

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state option is used to mention the existence of user mapping rule.
    type: str

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

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

new_order:
    description:
    - New order in which the user mapping rule should be applied.
    type: int

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.
    - C(true) - indicates that the SSL certificate should be verified.
    - C(false) - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

access_zone:
    default: System
    description: The zone to which the user mapping applies.
    type: str

apply_order:
    description:
    - Current order in which the user mapping rule is applied.
    type: int

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

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
user_mapping_rule_details:
  contains:
    apply_order:
      description: Current order of the rule.
      type: int
    operator:
      description: The operation that a rule carries out.
      type: str
    options:
      contains:
        _break:
          description: If C(true), and the rule was applied successfuly, stop processing
            further.
          type: bool
        default_user:
          contains:
            domain:
              description: The name of domain.
              type: str
            user:
              description: The username of the user.
              type: str
          description: If the mapping service fails to find the second user in a rule,
            the service tries to find the username of the default user..
          type: dict
        group:
          description: If C(true), the primary GID and primary group SID should be
            copied to the existing credential.
          type: bool
        groups:
          description: If C(true), all additional identifiers should be copied to
            the existing credential.
          type: bool
        user:
          description: If C(true), the primary UID and primary user SID should be
            copied to the existing credential.
          type: bool
      description: Specifies the properties for user mapping rules.
      type: dict
    user1:
      contains:
        domain:
          description: The name of domain.
          type: str
        user:
          description: The username of the user.
          type: str
      description: A UNIX user or an Active Directory user.
      type: dict
    user2:
      contains:
        domain:
          description: The name of domain.
          type: str
        user:
          description: The username of the user.
          type: str
      description: A UNIX user or an Active Directory user.
      type: dict
  description: Rule details.
  returned: When a rule exists
  sample:
    user_mapping_rule_details:
      apply_order: 7
      operator: insert
      options:
        _break: false
        default_user: null
        group: true
        groups: true
        user: true
      user1:
        domain: null
        user: test_ans_user
      user2:
        domain: null
        user: Test_userAnand
  type: dict