Onboarding New Devices into GLP and Central
Source CodeYou can find this playbook in the collection repository:
examples/onboarding_example.yml
This playbook takes devices that are not yet in GLP inventory through the full onboarding journey: it registers them in GLP, assigns them an application and subscription, then creates a site, device group, and persona for them in Central. For configuration management (not just monitoring), devices must be assigned to a device group and a persona.
Proof of ConceptThis playbook is for demonstrating the onboarding sequence. It is not optimized for large-scale onboarding — see Bulk Onboarding Devices from GLP Inventory for a version that dynamically maps devices already in GLP inventory.
Prerequisites
- A GreenLake workspace, New Central account, and Classic Central account with API access enabled
- Device serial numbers and MAC addresses for the devices you're onboarding
- A valid subscription key with available seats
- The
hostsfield in this playbook targets aprod_instancegroup — update it tolocalhostor an inventory group that resolves for your environment
Installation
- Install the collection from Ansible Galaxy:
ansible-galaxy collection install arubanetworks.hpeanw_central- Install the
pycentralv2 SDK, which the collection depends on:
pip3 install --pre pycentralThis workflow is tested on collection version 2.1.1-beta. Please check compatibility before executing on older/newer versions as there may be changes.
Configuration(Advanced)
Credentials Configuration (inventory.yml)
all:
hosts:
localhost:
ansible_connection: local # Do not change
glp_client_id: <glp-client-id>
glp_client_secret: <glp-client-secret>
central_base_url: <new-central-api-base-url>
central_client_id: <new-central-client-id>
central_client_secret: <new-central-client-secret>
classic_base_url: <classic-central-api-base-url>
classic_access_token: <classic-central-access-token>
Important Links
Playbook Variables
| Variable | Description |
|---|---|
site_name | Name of the site to create in Central |
group_name | Name of the device group to create in Central |
Execution
The playbook runs through onboarding in order: register devices in GLP, assign them to an application/subscription, create the site in Central, assign devices to that site, create/assign a device group, then assign device personas.
- name: Onboard Devices into HPE Aruba Networking Central
hosts: prod_instance
gather_facts: no
vars:
site_name: "Ansible-Campus"
group_name: "Ansible-APs"
tasks:
- name: Generate Token for Session
arubanetworks.hpeanw_central.glp_token:
client_id: "{{ glp_client_id }}"
client_secret: "{{ glp_client_secret }}"
register: token_result
no_log: True
- name: Add Devices to GLP Inventory
arubanetworks.hpeanw_central.glp_inventory:
access_token: "{{ token_result['access_token'] }}"
devices:
- serial_number: PHQSL1116K
mac_address: 8c:85:cc:55:c0:81
- serial_number: PHQSL222HB
mac_address: 8c:00:c1:44:4c:40
state: "merged"
- name: Assign Devices to GLP & Assign subscriptions
arubanetworks.hpeanw_central.glp_devices:
access_token: "{{ token_result['access_token'] }}"
application:
name: HPE Aruba Networking Central
region: "US West"
subscription_key: "11122244455566677788899900011"
devices:
- "PHQSL1116K"
- "PHQSL222HB"
state: "assigned"
- name: Create OAuth Token from Central
arubanetworks.hpeanw_central.central_token:
base_url: "{{ central_base_url }}"
client_id: "{{ central_client_id }}"
client_secret: "{{ central_client_secret }}"
register: token_result
no_log: True
- set_fact:
central_access_token: "{{ token_result['access_token'] }}"
no_log: True
- name: Create Site Ansible_Site in Central
arubanetworks.hpeanw_central.central_sites:
base_url: "{{ central_base_url }}"
access_token: "{{ central_access_token }}"
site_attributes:
name: "{{ site_name }}"
address: "123 Main St"
city: "San Jose"
state: "California"
country: "United States"
zipcode: "12345"
timezone: "America/Los_Angeles"
state: merged
- name: Assign Devices to Sites in Classic HPE Aruba Networking Central
arubanetworks.hpeanw_central.classic_sites:
base_url: "{{ classic_base_url }}"
access_token: "{{ classic_access_token }}"
site_name: "{{ site_name }}"
device_type: "ACCESS_POINT"
devices:
- "PHQSL1116K"
- "PHQSL222HB"
state: assigned
- name: Create Group and Assign Devices to Group for Configuration in HPE Aruba Networking Central
arubanetworks.hpeanw_central.classic_groups:
base_url: "{{ classic_base_url }}"
access_token: "{{ classic_access_token }}"
group_name: "{{ group_name }}"
group_attributes:
template_info:
Wired: false
group_properties:
AllowedDevTypes:
- AccessPoints
Architecture: AOS10
ApNetworkRole: Standard
NewCentral: true
device_type: "ACCESS_POINT"
devices:
- "PHQSL1116K"
- "PHQSL222HB"
state: merged
- name: Assign Device Functions/Personas in HPE Aruba Networking Central
arubanetworks.hpeanw_central.central_api:
base_url: "{{ central_base_url }}"
access_token: "{{ central_access_token }}"
method: POST
path: "/network-config/v1alpha1/persona-assignment"
data:
persona-device-list:
- device-function: "CAMPUS_AP"
device-id:
- "PHQSL1116K"
- "PHQSL222HB"Run it with:
ansible-playbook -i inventory.yml onboarding_example.ymlOutput
Each step reports its own module-specific result (changed, msg, result/devices). There is no consolidated summary — inspect each registered variable, or add debug tasks, to confirm every step succeeded before moving on to configuration.
Troubleshooting
| Problem | Fix |
|---|---|
hosts: prod_instance has no matching hosts | Change hosts to localhost or a group defined in your inventory |
| GLP inventory add fails | Verify serial numbers and MAC addresses are correct and devices aren't already registered to another workspace |
| Persona assignment fails | Devices must be assigned to a site and device group before persona assignment succeeds |
Support
- Automation Team: [email protected]
- Collection Issues: GitHub Issues
Updated 4 months ago