arubanetworks.aruba_central.central_groups (1.0.3) — module

Install collection

Install with ansible-galaxy collection install arubanetworks.aruba_central:==1.0.3

Add to requirements.yml

  collections:
    - name: arubanetworks.aruba_central
      version: 1.0.3

Description

This module provides a mechanism to interact with groups used for configuration management of devices on Aruba Central.

Usage examples

Scanned by Steampunk Spotter

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

#Usage Examples
- name: Get all the UI and template groups on Central
  central_groups:
    action: get_groups
    limit: 20
    offset: 0

Scanned by Steampunk Spotter

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

- name: Get groups' configuration modes ("UI" or "template")
  central_groups:
    action: get_group_mode
    group_list:
      - group-name-1
      - group-name-2

Scanned by Steampunk Spotter

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

- name: Create a new group ("template" for wired, "UI" for wireless)
  central_groups:
    action: create
    group_name: new-test-group
    group_attributes:
      group_password: admin@12345
      template_group:
        wired: True
        wireless: False

Scanned by Steampunk Spotter

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

- name: Update an existing group (only available for UI groups)
  central_groups:
    action: update
    group_name: new-test-group
    group_attributes:
      group_password: Aruba@2222
      template_group: False

Scanned by Steampunk Spotter

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

- name: Clone an existing group
  central_groups:
    action: clone
    group_name: new-group
    clone_from_group: new-test-group

Scanned by Steampunk Spotter

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

- name: Delete a group
  central_groups:
    action: delete
    group_name: new-test-group

Inputs

    
limit:
    default: 20
    description:
    - Maximum number of records to be returned
    - Used optionally as a filter parameter for I(get_groups)
    required: false
    type: int

action:
    choices:
    - get_groups
    - get_group_mode
    - clone
    - update
    - create
    - delete
    description:
    - Action to be performed on the group(s)
    - I(get_groups) gets names of existing groups
    - I(get_group_mode) gets group modes of existing groups
    - I(clone) creates a new group by cloning an existing group
    - I(update) updates the group password of an existing UI group
    - I(create) creates a new group
    - I(delete) deletes an existing group
    required: true
    type: str

offset:
    default: 0
    description:
    - Number of items to be skipped before returning the data, which is useful for pagination
    - Used optionally as a filter parameter for I(get_groups)
    required: false
    type: int

group_list:
    description:
    - List of group names
    - At most 20 names can be listed
    - Used with action I(get_group_mode)
    required: false
    type: list

group_name:
    description:
    - Name of the group
    - Used with actions I(clone), I(update), I(create), and I(delete)
    required: false
    type: str

clone_from_group:
    description:
    - Name of existing group from which the new group is cloned
    - Used with action I(clone)
    required: false
    type: str

group_attributes:
    description:
    - Group attributes to define group password and a boolean determining whether it is
      a template group or UI group OR dictionary containing two booleans to determine
      the allowable templates (wired and/or wireless) for the template group
    - Used with actions I(create) and I(update)
    required: false
    type: dict