cisco.meraki.organizations_wireless_devices_provisioning_deployments module -- Resource module for organizations _wireless _devices _provisioning _deployments
Note
This module is part of the cisco.meraki collection (version 2.23.0).
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.organizations_wireless_devices_provisioning_deployments.
New in cisco.meraki 1.0.0
Synopsis
Manage operations create, update and delete of the resource organizations _wireless _devices _provisioning _deployments.
Create a zero touch deployment for a wireless access point.
Delete a zero touch deployment.
Update a zero touch deployment.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
DeploymentId path parameter. Deployment ID. |
|
List of zero touch deployments to create. |
|
Timestamp of when the zero touch deployment request was completed. |
|
Timestamp of when the zero touch deployment request was created. |
|
Zero touch deployment request identifier. |
|
An array composed of old and new devices. |
|
New device. |
|
MAC address of the new device. |
|
Model of the new device. |
|
Name of the new device or serial number if not named. |
|
RF profile of the new device. |
|
ID of RfProfile for new device. |
|
Name of RfProfile for new device. |
|
Serial number of the new device. |
|
Tag(s) of the new device. |
|
Old device. |
|
Action to be taken on the old device. |
|
MAC address of the old device. |
|
Model of the old device. |
|
Name of the old device. |
|
RF profile of the old device. |
|
ID of the RF profile. |
|
Name of the RF profile. |
|
Serial number of the old device. |
|
Tag(s) of the old device. |
|
Array of error message(s) if any. |
|
Timestamp of when the zero touch deployment request was last updated. |
|
Network information. |
|
ID of the network the device is being added to. |
|
Name of the network the device is being added to. |
|
Timestamp of when the zero touch deployment request was created. |
|
Status of the zero touch deployment request. Enum = ready, in progress, completed, failed. |
|
Type of the zero touch deployment request. Enum = deploy, replace. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: :ansible-option-default:`60` |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: :ansible-option-default:`"https://api.meraki.com/api/v1"` |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: :ansible-option-default:`""` |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: :ansible-option-default:`""` |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices: |
|
meraki_log_file_prefix (string), log file name appended with date and timestamp |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: :ansible-option-default:`""` |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: :ansible-option-default:`2` |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: :ansible-option-default:`60` |
|
meraki_output_log (boolean), create an output log file? Choices: |
|
meraki_print_console (boolean), print logging output to console? Choices: |
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: :ansible-option-default:`""` |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices: |
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: :ansible-option-default:`60` |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices: |
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: :ansible-option-default:`60` |
|
meraki_suppress_logging (boolean), disable all logging? you're on your own then! Choices: |
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices: |
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices: |
|
Metadata relevant to the paginated dataset. |
|
Counts relating to the paginated dataset. |
|
Counts relating to the paginated items. |
|
The number of items in the dataset that are available on subsequent pages. |
|
The total number of items in the dataset. |
|
OrganizationId path parameter. Organization ID. |
Notes
Note
SDK Method used are wireless.Wireless.create_organization_wireless_devices_provisioning_deployment, wireless.Wireless.delete_organization_wireless_devices_provisioning_deployment, wireless.Wireless.update_organization_wireless_devices_provisioning_deployments,
Paths used are post /organizations/{organizationId}/wireless/devices/provisioning/deployments, delete /organizations/{organizationId}/wireless/devices/provisioning/deployments/{deploymentId}, put /organizations/{organizationId}/wireless/devices/provisioning/deployments,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager
from Cisco Dashboard API Python(SDK)
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for wireless createOrganizationWirelessDevicesProvisioningDeployment
Complete reference of the createOrganizationWirelessDevicesProvisioningDeployment API.
- Cisco Meraki documentation for wireless deleteOrganizationWirelessDevicesProvisioningDeployment
Complete reference of the deleteOrganizationWirelessDevicesProvisioningDeployment API.
- Cisco Meraki documentation for wireless updateOrganizationWirelessDevicesProvisioningDeployments
Complete reference of the updateOrganizationWirelessDevicesProvisioningDeployments API.
Examples
- name: Create
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: present
items:
- completedAt: "2018-02-11T00:00:00.090210Z"
createdAt: "2018-02-11T00:00:00.090210Z"
deploymentId: "1284392014819"
devices:
new:
mac: 00:11:22:33:44:55
model: CW9166I
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
old:
afterAction: unclaim
mac: 00:11:22:33:44:55
model: MR34
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
errors:
- error message1
- error message2
lastUpdatedAt: "2018-02-11T00:00:00.090210Z"
network:
id: N_24329156
name: Main Office
requestedAt: "2018-02-11T00:00:00.090210Z"
status: ready
type: replace
meta:
counts:
items:
remaining: 0
total: 20
organizationId: string
- name: Update all
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: present
items:
- completedAt: "2018-02-11T00:00:00.090210Z"
createdAt: "2018-02-11T00:00:00.090210Z"
deploymentId: "1284392014819"
devices:
new:
mac: 00:11:22:33:44:55
model: CW9166I
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
old:
afterAction: unclaim
mac: 00:11:22:33:44:55
model: MR34
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
errors:
- error message1
- error message2
lastUpdatedAt: "2018-02-11T00:00:00.090210Z"
network:
id: N_24329156
name: Main Office
requestedAt: "2018-02-11T00:00:00.090210Z"
status: ready
type: replace
meta:
counts:
items:
remaining: 0
total: 20
organizationId: string
- name: Delete by id
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: absent
deploymentId: string
organizationId: string
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 Meraki Python SDK Returned: always |