Access Point
Catalyst CenterLocation in GUI:
Provision » Network Devices » Inventory
Diagram
Section titled “Diagram”Classes
Section titled “Classes”devices (catalyst_center.inventory)
Section titled “devices (catalyst_center.inventory)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_point | Class | [access_point] | No |
access_point (catalyst_center.inventory.devices)
Section titled “access_point (catalyst_center.inventory.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| configuration | String | No | ||
| manage_hostname | Boolean | true, false | No | false |
The access_point block on a device carries two things and nothing else:
| Attribute | Purpose |
|---|---|
configuration | Name of an entry under wireless.access_point_configurations to apply to this access point |
manage_hostname | When true, rename the access point in Catalyst Center to the device’s name. Defaults to false |
Radio and controller settings are deliberately not available here. The Configure Access Points intent API applies every setting except the hostname to the whole request, so a per-device override would silently fork that access point into an API call of its own. Declaring settings once under wireless.access_point_configurations keeps the number of API calls bounded by the number of configurations, and makes the grouping visible in the plan.
The block only applies to devices with type: AccessPoint that reach a PROVISION state.
Identification
Section titled “Identification”Applying a configuration resolves the access point by serial_number, name or fqdn_name — whichever is present.
manage_hostname: true additionally requires serial_number. A rename changes the hostname the access point would be found by, so driving it from name or fqdn_name would stop resolving the moment the rename succeeded. Catalyst Center also assigns access point hostnames at claim time and access point management IPs are ephemeral, which makes the serial number the only identifier known up front — so it is the recommended one in every case, not just for renames.
Renaming is idempotent: the desired name is always sent, the API identifies the access point by its ethernet MAC, and renaming an access point to the name it already holds is a no-op.
An access point that has not been claimed yet has no ethernet MAC in inventory and is skipped with a warning rather than failing the run, so a rollout can be described from the bill of materials and applied progressively as the hardware arrives.
Examples
Section titled “Examples”Example-1: Apply a Configuration
Section titled “Example-1: Apply a Configuration”catalyst_center: inventory: devices: - name: AP-ZRH-01 type: AccessPoint serial_number: FGL2402L1AB site: Global/CH/Zurich/HQ state: PROVISION rf_profile: BASIC_PROFILE_1 device_role: ACCESS access_point: configuration: OFFICE_STANDARDExample-2: Apply a Configuration and Reconcile the Hostname
Section titled “Example-2: Apply a Configuration and Reconcile the Hostname”catalyst_center: inventory: devices: - name: AP-ZRH-02 type: AccessPoint serial_number: FGL2402L1AC site: Global/CH/Zurich/HQ state: PROVISION rf_profile: BASIC_PROFILE_1 device_role: ACCESS access_point: configuration: OFFICE_STANDARD manage_hostname: trueExample-3: Rename Only
Section titled “Example-3: Rename Only”An access point with no configuration is renamed without any settings being applied.
catalyst_center: inventory: devices: - name: AP-ZRH-03 type: AccessPoint serial_number: FGL2402L1AD site: Global/CH/Zurich/HQ state: PROVISION rf_profile: BASIC_PROFILE_1 device_role: ACCESS access_point: manage_hostname: trueExample-4: Manage Every Hostname by Default
Section titled “Example-4: Manage Every Hostname by Default”manage_hostname can be set once under defaults instead of per device.
defaults: catalyst_center: inventory: devices: access_point: manage_hostname: true
catalyst_center: inventory: devices: - name: AP-ZRH-04 type: AccessPoint serial_number: FGL2402L1AE site: Global/CH/Zurich/HQ state: PROVISION rf_profile: BASIC_PROFILE_1 device_role: ACCESS access_point: configuration: OFFICE_STANDARD # opts out of the default - name: AP-ZRH-05 type: AccessPoint serial_number: FGL2402L1AF site: Global/CH/Zurich/HQ state: PROVISION rf_profile: BASIC_PROFILE_1 device_role: ACCESS access_point: configuration: OFFICE_STANDARD manage_hostname: false