dellemc.powerscale.dellemc_powerscale_groupnet (1.4.0) — module

Manages groupnet configuration on PowerScale

| "added in version" 1.4.0 of dellemc.powerscale"

Authors: Jennifer John (@johnj9) <ansible.team@dell.com>

preview | supported by community

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 groupnet configuration on the PowerScale storage system. This includes creating, modifying, deleting and retrieving the details of the groupnet.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      description: "Test Groupnet"
      dns_servers:
        - '198.10.**.***'
      dns_server_state: 'add'
      dns_search_suffix:
        - 'samplesearch.com'
      dns_search_suffix_state: 'add'
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add dns_servers to a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      dns_servers:
        - '198.10.**.***'
      dns_server_state: 'add'
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove dns_servers from a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      dns_servers:
        - '198.10.**.***'
      dns_server_state: 'remove'
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add dns_search_suffix to a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      dns_search_suffix:
        - 'samplesearch.com'
      dns_search_suffix_state: 'add'
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove dns_search_suffix from a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      dns_search_suffix:
        - 'samplesearch.com'
      dns_search_suffix_state: 'remove'
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Rename a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      new_groupnet_name: "groupnet_test_rename"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get groupnet details
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a groupnet
  dellemc_powerscale_groupnet:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet_test"
      state: "absent"

Inputs

    
state:
    choices:
    - present
    - absent
    description:
    - The state of the groupnet after the task is performed.
    - present - indicates that the groupnet should exist on the system.
    - absent - indicates that the groupnet 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

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

description:
    description: A description of the groupnet.
    type: str

dns_servers:
    description:
    - List of Domain Name Server IP addresses.
    elements: str
    type: list

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

groupnet_name:
    description:
    - The name of the groupnet.
    required: true
    type: str

dns_server_state:
    choices:
    - add
    - remove
    description:
    - Specifies if the dns_servers should be added or removed from the groupnet.
    type: str

dns_search_suffix:
    description:
    - List of DNS search suffixes.
    elements: str
    type: list

new_groupnet_name:
    description: Name of the groupnet when renaming an existing groupnet
    type: str

dns_search_suffix_state:
    choices:
    - add
    - remove
    description:
    - Specifies if the dns search suffix should be added or removed from the groupnet.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool
groupnet_details:
  contains:
    dns_search:
      description: List of DNS search suffixes
      type: list
    dns_servers:
      description: List of Domain Name Server IP addresses
      type: list
    id:
      description: Unique Groupnet ID.
      type: str
    name:
      description: Name of groupnet
      type: str
    subnets:
      description: List of names of the subnets in the groupnet
      type: list
  description: Groupnet details
  returned: When a groupnet exists
  type: complex