cisco.meraki.networks_clients_provision module – Resource module for networks _clients _provision
Note
This module is part of the cisco.meraki collection (version 2.18.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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.networks_clients_provision
.
New in cisco.meraki 2.16.0
Synopsis
Manage operation create of the resource networks _clients _provision.
Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.
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 |
---|---|
The array of clients to provision. |
|
The MAC address of the client. Required. |
|
The display name for the client. Optional. Limited to 255 bytes. |
|
The policy to apply to the specified client. Can be ‘Group policy’, ‘Allowed’, ‘Blocked’, ‘Per connection’ or ‘Normal’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
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: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy 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 Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
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: |
|
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: |
|
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: |
|
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:
|
|
NetworkId path parameter. Network ID. |
|
An object, describing what the policy-connection association is for the security appliance. (Only relevant if the security appliance is actually within the network). |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’ or ‘Normal’. Required. |
|
An object, describing the policy-connection associations for each active SSID within the network. Keys should be the number of enabled SSIDs, mapping to an object describing the client’s policy. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
|
The number for the SSID. |
|
The policy to apply to the specified client. Can be ‘Allowed’, ‘Blocked’, ‘Normal’ or ‘Group policy’. Required. |
|
The ID of the desired group policy to apply to the client. Required if ‘devicePolicy’ is set to “Group policy”. Otherwise this is ignored. |
Notes
Note
SDK Method used are networks.Networks.provision_network_clients,
Paths used are post /networks/{networkId}/clients/provision,
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC 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 networks provisionNetworkClients
Complete reference of the provisionNetworkClients API.
Examples
- name: Create
cisco.meraki.networks_clients_provision:
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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
clients:
- mac: 00:11:22:33:44:55
name: Miles's phone
devicePolicy: Group policy
groupPolicyId: '101'
networkId: string
policiesBySecurityAppliance:
devicePolicy: Normal
policiesBySsid:
'0':
devicePolicy: Group policy
groupPolicyId: '101'
'1':
devicePolicy: Group policy
groupPolicyId: '101'
'10':
devicePolicy: Group policy
groupPolicyId: '101'
'11':
devicePolicy: Group policy
groupPolicyId: '101'
'12':
devicePolicy: Group policy
groupPolicyId: '101'
'13':
devicePolicy: Group policy
groupPolicyId: '101'
'14':
devicePolicy: Group policy
groupPolicyId: '101'
'2':
devicePolicy: Group policy
groupPolicyId: '101'
'3':
devicePolicy: Group policy
groupPolicyId: '101'
'4':
devicePolicy: Group policy
groupPolicyId: '101'
'5':
devicePolicy: Group policy
groupPolicyId: '101'
'6':
devicePolicy: Group policy
groupPolicyId: '101'
'7':
devicePolicy: Group policy
groupPolicyId: '101'
'8':
devicePolicy: Group policy
groupPolicyId: '101'
'9':
devicePolicy: Group policy
groupPolicyId: '101'
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 Sample: |