cisco.meraki.devices_appliance_interfaces_ports_update module -- Resource module for devices _appliance _interfaces _ports _update
Note
This module is part of the cisco.meraki collection (version 2.25.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.devices_appliance_interfaces_ports_update.
New in cisco.meraki 1.0.0
Synopsis
Manage operation create of the resource devices _appliance _interfaces _ports _update.
Update configurations for an appliance's specified port.
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 port's VLAN settings when in LAN mode. |
|
The port's settings when in 'access' mode. |
|
The access policy settings for this port. |
|
The access policy that will be enforced by the 'access' VLAN. |
|
The VLAN for which this port will accept and pass traffic in 'access' mode. All untagged traffic will automatically be treated as if it belonged to this VLAN. |
|
Indicates whether the port is in 'trunk' or 'access' mode. |
|
Security Group Tag settings for this port. |
|
Adaptive policy group ID that all traffic originating from this port is assigned to. |
|
The port's settings when in 'trunk' mode. |
|
The VLANs for which this port will accept and pass traffic in 'trunk' mode. This must include the Native VLAN if one is set. |
|
The Native VLAN for the port. All untagged traffic that comes in on this port will be treated as if it belonged to this VLAN. This can also be set to 0 to drop untagged traffic. |
|
Security Group Tag settings for this trunk port. |
|
Indicates whether the trunk port is Peer SGT capable. Choices: |
|
Indicates whether the port is enabled. Choices: |
|
The interface tuple used to identify the port. |
|
The leaf port number. |
|
The slot number for the port. |
|
The subslot number for the port. |
|
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: |
|
Describes the port's configurability. |
|
Describes the port's layer configurability. |
|
The layer at which the port operates. |
|
The type of interface, 'wan' or 'lan', the port is configured as. |
|
Serial path parameter. |
|
The port's settings when in WAN mode. |
|
Describes the uplink device. |
Notes
Note
SDK Method used are appliance.Appliance.create_device_appliance_interfaces_ports_update,
Paths used are post /devices/{serial}/appliance/interfaces/ports/update,
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 appliance createDeviceApplianceInterfacesPortsUpdate
Complete reference of the createDeviceApplianceInterfacesPortsUpdate API.
Examples
- name: Create
cisco.meraki.devices_appliance_interfaces_ports_update:
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 }}"
downlink:
access:
policy:
type: 802.1X
vlan: '1'
mode: access
sgt:
id: '1234'
trunk:
allowedVlans:
- '2'
- '3'
- '4'
- '5'
nativeVlan: '2'
sgt:
enabled: false
enabled: true
interface:
number: 3
slot: 1
subslot: 2
personality:
layer:
mode: 3
mode: wan
serial: string
uplink:
type: ethernet
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 |