Try SpotterREST API module for devices on Aruba Central
| "added in version" 2.9.0 of arubanetworks.aruba_central"
Authors: unknown
preview | supported by community
Install with ansible-galaxy collection install arubanetworks.aruba_central:==1.0.3
collections:
- name: arubanetworks.aruba_central
version: 1.0.3This module provides a mechanism to interact with devices to perform device-pertinent operations
#Usage Examples
- name: Move devices to a group
central_devices:
action: move_devices
group_name: new-group
device_serial_list:
- CNXXXXXXXX
- CNXXXXXXYY
- name: Get group name to which a device belongs
central_devices:
action: get_device_group
device_serial: CNXXXXXXXX
- name: Get the last known running configuration of a device
central_devices:
action: get_running_config
device_serial: CNXXXXXXXX
- name: Get configuration details of a device (only for devices in template groups) # NOQA
central_devices:
action: get_config_details
device_serial: CNXXXXXXXX
full_details: False
- name: Get template info for listed devices
central_devices:
action: get_template_info
device_serial_list:
- CNXXXXXXXX
- CNXXXXXXYY
- CNXXXXXXZZ
- name: Get template info for devices in all groups
central_devices:
action: get_templates_for_groups
limit: 20
offset: 0
device_type: IAP
- name: Get template info for devices in all groups, except specified groups # NOQA
central_devices:
action: get_templates_for_group
limit: 20
offset: 0
exclude_groups:
- group-name-1
- group-name-2
device_type: IAP
- name: Get template info for devices in specified groups
central_devices:
action: get_templates_for_groups
limit: 20
offset: 0
include_groups:
- group-name-1
- group-name-2
device_type: IAP
- name: Get template info for devices using given template hash (Only allowed for users having all_groups access or admin) # NOQA
central_devices:
action: get_templates_using_hash
template_hash: f6f4d3cxxxxxxxxxxxxxxxxxxxxxxx
limit: 20
offset: 0
exclude_hash: False
device_type: IAP
- name: Get template body and variables info for an Aruba Switch
central_devices:
action: get_variablised_switch_template
device_serial: CNXXXXXXXX
- name: Set SSH username and password for an Aruba Switch
central_devices:
action: set_switch_ssh_connection
device_serial: CNXXXXXXXX
sw_username: test@test.com
sw_password: test@123
limit:
default: 20
description:
- Maximum number of records to be returned. It is used optionally as a filter parameter
for I(get_templates_for_groups) and I(get_templates_using_hash)
required: false
type: int
action:
choices:
- get_device_group
- get_running_config
- get_config_details
- get_template_info
- get_templates_for_groups
- get_templates_using_hash
- get_variablised_switch_template
- set_switch_ssh_connection
- move_devices
description:
- Action to be performed on the device(s)
- I(get_device_group) gets the name of the group that a device belongs to
- I(get_running_config) gets last known running-config of a device as multipart/form-data
- I(get_config_details) gets configuration details for a device belonging to a template
group. It applicable only to devices in template groups. It gets the following details-
Central-side configuration; Device running configuration; Configuration error details;
Template error details and status of device;
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_templates_for_groups) and I(get_templates_using_hash)
required: false
type: int
group_name:
description:
- Name of the group
- Used with action I(move_devices)
required: false
type: str
device_type:
choices:
- IAP
- ArubaSwitch
- CX
- MobilityController
description:
- Type of device for which the template is applicable
- Used with actions I(get_templates_for_groups) and "get_templates_using_hash"
required: false
type: str
sw_password:
description:
- Switch password to establish SSH connection to AOS-S switch
- Used with action I(set_switch_ssh_connection)
required: false
type: str
sw_username:
description:
- Switch username to establish SSH connection to AOS-S switch
- Used with action I(set_switch_ssh_connection)
required: false
type: str
exclude_hash:
default: false
description:
- Determines behavior of I(get_templates_using_hash)
- Used with action I(get_templates_using_hash)
required: false
type: bool
full_details:
default: false
description:
- Used with action I(get_config_details) action to determine whether the action retrieves
a summary of device configuration info or the comprehensive details of device configuration
info
- Specify as true only if the detailed response of a device's configuration info is
required, as passing true might result in slower API response and performance
required: false
type: bool
device_serial:
description:
- Serial number of the device
- Used with actions I(get_device_group), I(get_running_config), I(get_config_details),
I(get_variablised_switch_template), and I(set_switch_ssh_connection)
required: false
type: str
template_hash:
description:
- Hash string of template for which I(get_templates_using_hash) either includes or
excludes
- Used with action "get_templates_using_hash"
- Behavior (inclusion or exclusion) determined by I(exclude_hash) parameter
required: false
type: str
exclude_groups:
description:
- List of group names for which I(get_templates_for_groups) will exclude
- Used with action I(get_templates_for_groups)
- Mutually exclusive with I(include_groups)
required: false
type: list
include_groups:
description:
- List of groups for which I(get_templates_for_groups) will include
- Used with action I(get_templates_for_groups)
- Mutually exclusive with I(exclude_groups)
required: false
type: list
device_serial_list:
description:
- List of device serial numbers
- Used with actions I(move_devices) and I(get_template_info)
- When moving an IAP, all APs in a cluster will be moved to the specified group if
the serial number of conductor AP is provided in this list; serial number(s) of
member IAP(s) will be ignored
required: false
type: list