arubanetworks.aruba_central.central_templates (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 or upload configuration templates that are used for group-level and device-level configuration 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 templates in a given group
  central_templates:
    action: get_all
    group_name: new-group
    limit: 20
    offset: 0

Scanned by Steampunk Spotter

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

- name: Get templates in a given group for a particular device type
  central_templates:
    action: get_all
    group_name: new-group
    device_type: IAP
    limit: 20
    offset: 0
    version: ALL
    model: ALL

Scanned by Steampunk Spotter

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

- name: Get template text
  central_templates:
    action: get_template_text
    group_name: new-group
    template_name: iap-temp

Scanned by Steampunk Spotter

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

- name: Upload a new template file and create a new template for a given device type  # NOQA
  central_templates:
    action: create
    group_name: new-group
    template_name: iap-temp
    device_type: IAP
    version: ALL
    model: ALL
    local_file_path: /home/iap_template.txt

Scanned by Steampunk Spotter

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

- name: Update an existing template
  central_templates:
    action: update
    group_name: new-group
    template_name: iap-temp
    device_type: IAP
    version: ALL
    model: ALL
    local_file_path: /home/modified_iap_template.txt

Scanned by Steampunk Spotter

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

- name: Delete an existing template
  central_templates:
    action: delete
    group_name: new-group
    template_name: iap-temp

Inputs

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

model:
    default: ALL
    description:
    - Model property of template
    - Used with action I(create)
    - Used optionally with actions I(get_all) and I(update)
    - For the "ArubaSwitch" device_type (i.e. AOS-S switches), the part number (J number)
      can be used - e.g. 2920, J9727A, etc.
    required: false
    type: str

action:
    choices:
    - get_template_text
    - get_all
    - update
    - create
    - delete
    description:
    - Action to be performed on the template(s)
    - I(get_template_text) gets the contents of a template
    - I(get_all) gets info on all templates in a group
    - I(update) updates attributes of an existing template
    - I(create) creates a new template in a group
    - I(delete) deletes an existing template from a 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 get_all
    required: false
    type: int

version:
    default: ALL
    description:
    - Firmware version property of template
    - Used with action I(create)
    - Used optionally with actions I(get_all) and I(update)
    required: false
    type: str

group_name:
    description:
    - Name of the group
    required: true
    type: str

device_type:
    choices:
    - IAP
    - ArubaSwitch
    - CX
    - MobilityController
    description:
    - Type of device for which the template file is applicable
    - Used with action I(create)
    - Used optionally with actions I(get_all) and I(update)
    required: false
    type: str

template_name:
    description:
    - Name of the template on Aruba Central
    - Used with actions I(get_template_text), I(create), I(update), and I(delete)
    required: false
    type: str

local_file_path:
    description:
    - Full local path of template file to be uploaded
    - For HP Switches, the template text should include the following commands to maintain
      connection with Central - aruba-central enable - aruba-central url U(https://< URL
      | IP >/ws)
    - Used with actions I(create) and I(update)
    required: false
    type: str