cisco.meraki.organizations_inventory_onboarding_cloud_monitoring_prepare module -- Resource module for organizations _inventory _onboarding _cloud _monitoring _prepare
Note
This module is part of the cisco.meraki collection (version 2.20.5).
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_inventory_onboarding_cloud_monitoring_prepare
.
New in cisco.meraki 2.16.0
Synopsis
Manage operation create of the resource organizations _inventory _onboarding _cloud _monitoring _prepare.
Initiates or updates an import session. An import ID will be generated and used when you are ready to commit the import.
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 |
---|---|
A set of devices to import (or update). |
|
Device SUDI certificate. |
|
TLS Related Parameters. |
|
Name of the configured TLS certificate. |
|
Number of the vlan expected to be used to connect to the cloud. |
|
Number of the configured Loopback Interface used for TLS overlay. |
|
Name of the configured TLS tunnel. |
|
User parameters. |
|
The name of the device user for Meraki monitoring. |
|
VTY Related Parameters. |
|
AccessList details. |
|
VTY in ACL. |
|
Name. |
|
VTY out ACL. |
|
Name. |
|
VTY AAA authentication. |
|
Group Details. |
|
Group Name. |
|
VTY AAA authorization. |
|
Group Details. |
|
Group Name. |
|
Ending line VTY number. |
|
SSH rotary number. |
|
Starting line VTY number. |
|
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: |
|
Additional options for the import. |
|
Flag to skip adding the device to RDM. Choices: |
|
OrganizationId path parameter. Organization ID. |
Notes
Note
SDK Method used are organizations.Organizations.create_organization_inventory_onboarding_cloud_monitoring_prepare,
Paths used are post /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare,
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 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 organizations createOrganizationInventoryOnboardingCloudMonitoringPrepare
Complete reference of the createOrganizationInventoryOnboardingCloudMonitoringPrepare API.
Examples
- name: Create
cisco.meraki.organizations_inventory_onboarding_cloud_monitoring_prepare:
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 }}'
devices:
- sudi: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw
gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ
RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu
YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3
MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK
uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u
pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2
aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML
USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE
1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh
a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/
UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg=
-----END CERTIFICATE-----'
tunnel:
certificateName: DeviceSUDI
localInterface: 1
loopbackNumber: 1000
name: MERAKI
user:
username: Meraki
vty:
accessList:
vtyIn:
name: MERAKI_IN
vtyOut:
name: MERAKI_OUT
authentication:
group:
name: ''
authorization:
group:
name: MERAKI
endLineNumber: 17
rotaryNumber: 50
startLineNumber: 16
options:
skipCommit: false
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 |