.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_controllers_intended_access_points_update_create module -- Resource module for Wireless Controllers Intended Access Points Update Create ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.wireless_controllers_intended_access_points_update_create`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Wireless Controllers Intended Access Points Update Create. - \> This API operation creates/updates/deletes an intended feature 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. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-apjoinprofiles: .. rst-class:: ansible-option-title **apJoinProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's apJoinProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-appacketcaptures: .. rst-class:: ansible-option-title **apPacketCaptures** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's apPacketCaptures. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-appowerprofiles: .. rst-class:: ansible-option-title **apPowerProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's apPowerProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-aptraceprofiles: .. rst-class:: ansible-option-title **apTraceProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's apTraceProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-calendarprofiles: .. rst-class:: ansible-option-title **calendarProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's calendarProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-meshprofiles: .. rst-class:: ansible-option-title **meshProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's meshProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-sitetagconfigs: .. rst-class:: ansible-option-title **siteTagConfigs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Intended Access Points Update Create's siteTagConfigs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.update\_configurations\_for\_an\_intended\_access\_point\_feature\_on\_a\_wireless\_controller, - Paths used are post /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/update, - Does not support \ :literal:`check\_mode`\ - The 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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Wireless UpdateConfigurationsForAnIntendedAccessPointFeatureOnAWirelessController `_ Complete reference of the UpdateConfigurationsForAnIntendedAccessPointFeatureOnAWirelessController API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.wireless_controllers_intended_access_points_update_create: 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}}" apJoinProfiles: 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: 40 apCfgProfileLedFlashSec: 0 apCfgProfileName: iota 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 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 op: CREATE 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 apPowerProfiles: apPowerProfileClientThreshold: 1 apPowerProfileName: zeta configType: AP_POWER_PROFILE deviceVersion: '17.16' op: CREATE networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_access_points_update_create_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors