cisco.catalystcenter.wireless_controllers_intended_access_points_ap_join_profiles module -- Resource module for Wireless Controllers Intended Access Points Ap Join Profiles
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.wireless_controllers_intended_access_points_ap_join_profiles.
New in cisco.catalystcenter 2.11.0
Synopsis
Manage operations create, update and delete of the resource Wireless Controllers Intended Access Points Ap Join Profiles. - > This API operation creates an intended ApJoinProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. - > This API operation deletes an intended ApJoinProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. Delete operations are not supported for default-ap-profile in any version. - > This API operation updates an intended ApJoinProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. When the intended features are deployed, they are applied on top of the existing configurations on the device. Any existing configurations on the device which are not included in the intended features, are retained on the device.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Id path parameter. Instance UUID of the ApJoinProfile. |
|
NetworkDeviceId path parameter. Network device ID of the wireless controller to provision. The API /dna/intent/api/v1/network-device can be used to get the network device ID. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are wireless.Wireless.create_a_new_configuration_for_an_intended_ap_join_profile_feature_on_a_wireless_controller, wireless.Wireless.delete_configurations_for_a_specific_instance_of_an_intended_ap_join_profile_feature_on_a_wireless_controller, wireless.Wireless.update_configurations_for_a_specific_instance_of_an_intended_ap_join_profile_feature_on_a_wireless_controller,
Paths used are post /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/apJoinProfiles, delete /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/apJoinProfiles/{id}, put /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/apJoinProfiles/{id},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Wireless CreateANewConfigurationForAnIntendedApJoinProfileFeatureOnAWirelessController
Complete reference of the CreateANewConfigurationForAnIntendedApJoinProfileFeatureOnAWirelessController API.
- Cisco Catalyst Center documentation for Wireless DeleteConfigurationsForASpecificInstanceOfAnIntendedApJoinProfileFeatureOnAWirelessController
Complete reference of the DeleteConfigurationsForASpecificInstanceOfAnIntendedApJoinProfileFeatureOnAWirelessController API.
- Cisco Catalyst Center documentation for Wireless UpdateConfigurationsForASpecificInstanceOfAnIntendedApJoinProfileFeatureOnAWirelessController
Complete reference of the UpdateConfigurationsForASpecificInstanceOfAnIntendedApJoinProfileFeatureOnAWirelessController API.
Examples
---
- name: Update by id
cisco.catalystcenter.wireless_controllers_intended_access_points_ap_join_profiles:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
accelerometerSensorEnabled: true
actionApReloadEnabled: false
adrIndividualAggrEnabled: false
adrIndividualEnabled: true
adrIndividualPcThrottle: 5
adrIndividualPtThrottle: 5
adrSummaryEnabled: false
alarmHoldTime: 6
alarmsEnabled: false
anomalyDetTriggerTraceAp: false
anomalyDetectionEnabled: false
antennaMonitorDetectionTime: 12
antennaMonitorEnabled: false
antennaMonitorRssiFailThreshold: 10
apCfgProfileLedFlashSec: 0
apCfgProfileName: rssithreshold
apCfgProfileStatsTimer: 180
apCountryCountryCode: UNCONFIGURED
apDeploymentModeType: AP_MODE_DEFAULT
apDtlsCtrlPrefEnabled: true
apLagEnabled: false
apNtpServerInfoKeyType: AP_NTP_KEY_TYPE_MD5
apRogueDetectionEnabled: true
apRogueDetectionMinRssi: -90
apRogueDetectionTransientInterval: 0
apStatsDnsEnabled: false
apStatsDnsFreq: 30
apStatsInterfaceEnabled: false
apStatsInterfaceFreq: 30
apStatsMemoryEnabled: false
apStatsMemoryFrequency: 30
apStatsRadioEnabled: false
apStatsRadioFrequency: 30
apStatsRoutingEnabled: false
apStatsRoutingFrequency: 30
apStatsSysEnabled: false
apStatsSystemFrequency: 30
apStatsWlanEnabled: false
apStatsWlanFreq: 30
apTrustsUpstreamDscpEnabled: true
apTzConfigMode: AP_TZ_NOT_CONFIGURED
apTzConfigOffsetHour: 0
apTzConfigOffsetMin: 0
apphostEnabled: false
auxClientInterfaceVlanId: 0
awipsEnabled: false
awipsForensicEnabled: false
bleBeaconAdvpwr: 59
bleBeaconInterval: 1
bleScanStateEnabled: false
bssidEnableStats: false
bssidNeighborStatsEnabled: false
bssidNeighborStatsFrequency: 180
bssidStatsFrequency: 30
capwapAggregationEnabled: false
capwapWindowWindowSize: 1
cdpEnabled: true
clientFilterStatsEnabled: false
clientFilterStatsFrequency: 5
clientRssiStatsEnabled: true
clientRssiStatsInterval: 30
clientStatsEnabled: false
clientStatsFrequency: 30
configType: AP_JOIN_PROFILE
coredumpFlagEnabled: TFTP_COREDUMP_DISABLE
corefileName: default
cpuThreshold: 0
dataEncryptionEnabled: false
deviceVersion: '17.16'
dhcpFallbackEnabled: true
dhcpServerEnabled: false
discoveryTimeout: 10
dot1xEapTypeInfoDot1xEapType: DOT1X_EAP_FAST
extModuleEnabled: false
fallbackEnabled: true
fastHeartBeatTimeout: 0
ftmEnabled: true
ftmInitBurstDuration: ENUM_32MS
ftmInitBurstSize: 16
gasRateLimitEnabled: false
grpcEnabled: false
heartBeatTimeout: 30
hyperlocationEnabled: false
icapAdrIndividualThrottle: 5
icapAdrSummaryFrequency: 5
icapAggrTraceEnabled: false
icapAnomalyDetDhcpTimeout: 5
icapFullTraceEnabled: false
id: string
injectorSwitchMacAddr: 00:00:00:00:00:00
isRfSpectrumSlot2Enabled: false
jumboMtuEnabled: false
kernelCoredumpLimit: 5
kernelCoredumpType: KERNEL_COREDUMP_TYPE_DISABLED
lawfulInterceptionEnabled: false
lawfulInterceptionTimerInterval: 60
ledFlashMode: LED_FLASH_MODE_INDEFINITE
ledStateEnabled: true
linkLatencyFlagEnabled: LINK_AUDITING_DISABLE
loginCredentialsDot1xPasswordType: CLEAR
lscApAuthTypeInfoAuthType: LSC_AP_AUTH_CAPWAP_DTLS
max1xSessionLimitPerAp: 0
maxCfgClients: 0
memThresholdStatsMonitor: 0
meshProfileName: default-mesh-profile
networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
nsiPortsStateEnabled: false
ntpServerInfoKeyFormat: AP_NTP_KEY_FORMAT_ASCII
ntpServerInfoKeyId: 1
ntpServerInfoNtpAddr: 0.0.0.0
oeapDataEncryptionEnabled: true
oeapLocalNet: true
oeapRogueDetectEnabled: false
onboardConfig: AP_OB_UNICAST
pakRssiThresholdDetection: -100
pakRssiThresholdReset: 8
pakRssiThresholdTrigger: 10
partialTraceEnabled: false
partialTraceProtoAll: false
partialTraceProtoCiscoAll: false
partialTraceProtoCiscoNdp: false
partialTraceProtoDataAll: false
partialTraceProtoDataArp: false
partialTraceProtoDataDhcp: false
partialTraceProtoDataDhcpv6: false
partialTraceProtoDataDns: false
partialTraceProtoDataEap: false
partialTraceProtoDataIcmp: false
partialTraceProtoDataIcmpv6: false
partialTraceProtoMgmtAll: false
partialTraceProtoMgmtAssoc: false
partialTraceProtoMgmtAuth: false
partialTraceProtoMgmtProbe: false
persistentSsidBroadcastEnabled: false
pmfDeauthEnabled: true
powerInjectorSelection: PWRINJ_UNKNOWN
powerInjectorStateEnabled: false
preStandard8023afSwitchFlag: false
pressSensConfigState: PRESS_SENSOR_AUTO
primaryControllerIpAddr: 0.0.0.0
primaryDiscoveryTimeout: 120
primedJoinTimeout: 0
privateIpDiscoveryEnabled: true
provisionalSsidEnabled: true
publicIpDiscoveryEnabled: true
qosmapActionFrameEnabled: true
radio24GhzReportingInterval: 90
radio5GhzReportingInterval: 90
radioResetEnabled: false
radioStatsMonitorAlarmsEnabled: false
radioStatsMonitorEnabled: false
retransmitTimerCount: 5
retransmitTimerInterval: 3
rfSpectrumEnabled: false
rfSpectrumSlot0Enabled: false
rfSpectrumSlot1Enabled: false
rfSpectrumSlot3Enabled: false
rlanFastSwitchingEnabled: false
rogueContainmentAutorate: false
rogueContainmentFlexconnect: false
rogueDetectionPmfDenial: false
rogueReportInterval: 10
sampleInterval: 720
sampleIntvl: 30
secondaryControllerIpAddr: 0.0.0.0
serialConsoleEnabled: true
spacesConnTokenType: CLEAR
sshEnabled: false
statsMonitorEnabled: false
statsMonitorStatsInterval: 300
syslogFacilityValue: FACILITY_KERN
syslogHostIpAddress: 255.255.255.255
syslogLogLevel: SYSLOG_LEVEL_INFORMATION
syslogTlsModeEnabled: false
tcpAdjustMss: 1250
tcpMssAdjustEnabled: true
telnetEnabled: false
tftpDowngradeIpAddress: 0.0.0.0
tftpServerIpAddress: 0.0.0.0
trafficDistributionInterval: 300
trafficDistributionStatus: true
trapRetxTime: 0
trustKeyType: CLEAR
tunnelPreferredMode: PREFERRED_MODE_UNCONFIG
tzConfigEnabled: false
udpLiteIpv6CapwapChecksumType: UDPLITE_CHECKSUM_DISABLED
usbModuleEnabled: false
userMgmtPasswordCryptType: CLEAR
userMgmtSecretType: CLEAR
uwbEnabled: true
uwbInitBurstDuration: 10
uwbInitBurstSize: 32
weakRssi: -60
- name: Delete by id
cisco.catalystcenter.wireless_controllers_intended_access_points_ap_join_profiles:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: absent
id: string
networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
- name: Create
cisco.catalystcenter.wireless_controllers_intended_access_points_ap_join_profiles:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
accelerometerSensorEnabled: true
actionApReloadEnabled: false
adrIndividualAggrEnabled: false
adrIndividualEnabled: true
adrIndividualPcThrottle: 5
adrIndividualPtThrottle: 5
adrSummaryEnabled: false
alarmHoldTime: 6
alarmsEnabled: false
anomalyDetTriggerTraceAp: false
anomalyDetectionEnabled: false
antennaMonitorDetectionTime: 12
antennaMonitorEnabled: false
antennaMonitorRssiFailThreshold: 10
apCfgProfileLedFlashSec: 0
apCfgProfileName: rssithreshold
apCfgProfileStatsTimer: 180
apCountryCountryCode: UNCONFIGURED
apDeploymentModeType: AP_MODE_DEFAULT
apDtlsCtrlPrefEnabled: true
apLagEnabled: false
apNtpServerInfoKeyType: AP_NTP_KEY_TYPE_MD5
apRogueDetectionEnabled: true
apRogueDetectionMinRssi: -90
apRogueDetectionTransientInterval: 0
apStatsDnsEnabled: false
apStatsDnsFreq: 30
apStatsInterfaceEnabled: false
apStatsInterfaceFreq: 30
apStatsMemoryEnabled: false
apStatsMemoryFrequency: 30
apStatsRadioEnabled: false
apStatsRadioFrequency: 30
apStatsRoutingEnabled: false
apStatsRoutingFrequency: 30
apStatsSysEnabled: false
apStatsSystemFrequency: 30
apStatsWlanEnabled: false
apStatsWlanFreq: 30
apTrustsUpstreamDscpEnabled: true
apTzConfigMode: AP_TZ_NOT_CONFIGURED
apTzConfigOffsetHour: 0
apTzConfigOffsetMin: 0
apphostEnabled: false
auxClientInterfaceVlanId: 0
awipsEnabled: false
awipsForensicEnabled: false
bleBeaconAdvpwr: 59
bleBeaconInterval: 1
bleScanStateEnabled: false
bssidEnableStats: false
bssidNeighborStatsEnabled: false
bssidNeighborStatsFrequency: 180
bssidStatsFrequency: 30
capwapAggregationEnabled: false
capwapWindowWindowSize: 1
cdpEnabled: true
clientFilterStatsEnabled: false
clientFilterStatsFrequency: 5
clientRssiStatsEnabled: true
clientRssiStatsInterval: 30
clientStatsEnabled: false
clientStatsFrequency: 30
configType: AP_JOIN_PROFILE
coredumpFlagEnabled: TFTP_COREDUMP_DISABLE
corefileName: default
cpuThreshold: 0
dataEncryptionEnabled: false
deviceVersion: '17.16'
dhcpFallbackEnabled: true
dhcpServerEnabled: false
discoveryTimeout: 10
dot1xEapTypeInfoDot1xEapType: DOT1X_EAP_FAST
extModuleEnabled: false
fallbackEnabled: true
fastHeartBeatTimeout: 0
ftmEnabled: true
ftmInitBurstDuration: ENUM_32MS
ftmInitBurstSize: 16
gasRateLimitEnabled: false
grpcEnabled: false
heartBeatTimeout: 30
hyperlocationEnabled: false
icapAdrIndividualThrottle: 5
icapAdrSummaryFrequency: 5
icapAggrTraceEnabled: false
icapAnomalyDetDhcpTimeout: 5
icapFullTraceEnabled: false
injectorSwitchMacAddr: 00:00:00:00:00:00
isRfSpectrumSlot2Enabled: false
jumboMtuEnabled: false
kernelCoredumpLimit: 5
kernelCoredumpType: KERNEL_COREDUMP_TYPE_DISABLED
lawfulInterceptionEnabled: false
lawfulInterceptionTimerInterval: 60
ledFlashMode: LED_FLASH_MODE_INDEFINITE
ledStateEnabled: true
linkLatencyFlagEnabled: LINK_AUDITING_DISABLE
loginCredentialsDot1xPasswordType: CLEAR
lscApAuthTypeInfoAuthType: LSC_AP_AUTH_CAPWAP_DTLS
max1xSessionLimitPerAp: 0
maxCfgClients: 0
memThresholdStatsMonitor: 0
meshProfileName: default-mesh-profile
networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
nsiPortsStateEnabled: false
ntpServerInfoKeyFormat: AP_NTP_KEY_FORMAT_ASCII
ntpServerInfoKeyId: 1
ntpServerInfoNtpAddr: 0.0.0.0
oeapDataEncryptionEnabled: true
oeapLocalNet: true
oeapRogueDetectEnabled: false
onboardConfig: AP_OB_UNICAST
pakRssiThresholdDetection: -100
pakRssiThresholdReset: 8
pakRssiThresholdTrigger: 10
partialTraceEnabled: false
partialTraceProtoAll: false
partialTraceProtoCiscoAll: false
partialTraceProtoCiscoNdp: false
partialTraceProtoDataAll: false
partialTraceProtoDataArp: false
partialTraceProtoDataDhcp: false
partialTraceProtoDataDhcpv6: false
partialTraceProtoDataDns: false
partialTraceProtoDataEap: false
partialTraceProtoDataIcmp: false
partialTraceProtoDataIcmpv6: false
partialTraceProtoMgmtAll: false
partialTraceProtoMgmtAssoc: false
partialTraceProtoMgmtAuth: false
partialTraceProtoMgmtProbe: false
persistentSsidBroadcastEnabled: false
pmfDeauthEnabled: true
powerInjectorSelection: PWRINJ_UNKNOWN
powerInjectorStateEnabled: false
preStandard8023afSwitchFlag: false
pressSensConfigState: PRESS_SENSOR_AUTO
primaryControllerIpAddr: 0.0.0.0
primaryDiscoveryTimeout: 120
primedJoinTimeout: 0
privateIpDiscoveryEnabled: true
provisionalSsidEnabled: true
publicIpDiscoveryEnabled: true
qosmapActionFrameEnabled: true
radio24GhzReportingInterval: 90
radio5GhzReportingInterval: 90
radioResetEnabled: false
radioStatsMonitorAlarmsEnabled: false
radioStatsMonitorEnabled: false
retransmitTimerCount: 5
retransmitTimerInterval: 3
rfSpectrumEnabled: false
rfSpectrumSlot0Enabled: false
rfSpectrumSlot1Enabled: false
rfSpectrumSlot3Enabled: false
rlanFastSwitchingEnabled: false
rogueContainmentAutorate: false
rogueContainmentFlexconnect: false
rogueDetectionPmfDenial: false
rogueReportInterval: 10
sampleInterval: 720
sampleIntvl: 30
secondaryControllerIpAddr: 0.0.0.0
serialConsoleEnabled: true
spacesConnTokenType: CLEAR
sshEnabled: false
statsMonitorEnabled: false
statsMonitorStatsInterval: 300
syslogFacilityValue: FACILITY_KERN
syslogHostIpAddress: 255.255.255.255
syslogLogLevel: SYSLOG_LEVEL_INFORMATION
syslogTlsModeEnabled: false
tcpAdjustMss: 1250
tcpMssAdjustEnabled: true
telnetEnabled: false
tftpDowngradeIpAddress: 0.0.0.0
tftpServerIpAddress: 0.0.0.0
trafficDistributionInterval: 300
trafficDistributionStatus: true
trapRetxTime: 0
trustKeyType: CLEAR
tunnelPreferredMode: PREFERRED_MODE_UNCONFIG
tzConfigEnabled: false
udpLiteIpv6CapwapChecksumType: UDPLITE_CHECKSUM_DISABLED
usbModuleEnabled: false
userMgmtPasswordCryptType: CLEAR
userMgmtSecretType: CLEAR
uwbEnabled: true
uwbInitBurstDuration: 10
uwbInitBurstSize: 32
weakRssi: -60
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` |