Try SpotterResource module for networks _switch _portschedules
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operations create, update and delete of the resource networks _switch _portschedules.
Add a switch port schedule.
Delete a switch port schedule.
Update a switch port schedule.
- name: Create
cisco.meraki.networks_switch_port_schedules:
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}}"
state: present
name: Weekdays schedule
networkId: string
portSchedule:
friday:
active: true
from: '9:00'
to: '17:00'
monday:
active: true
from: '9:00'
to: '17:00'
saturday:
active: false
from: 0:00
to: '24:00'
sunday:
active: false
from: 0:00
to: '24:00'
thursday:
active: true
from: '9:00'
to: '17:00'
tuesday:
active: true
from: '9:00'
to: '17:00'
wednesday:
active: true
from: '9:00'
to: '17:00'
- name: Delete by id
cisco.meraki.networks_switch_port_schedules:
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}}"
state: absent
networkId: string
portScheduleId: string
- name: Update by id
cisco.meraki.networks_switch_port_schedules:
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}}"
state: present
name: Weekdays schedule
networkId: string
portSchedule:
friday:
active: true
from: '9:00'
to: '17:00'
monday:
active: true
from: '9:00'
to: '17:00'
saturday:
active: false
from: 0:00
to: '24:00'
sunday:
active: false
from: 0:00
to: '24:00'
thursday:
active: true
from: '9:00'
to: '17:00'
tuesday:
active: true
from: '9:00'
to: '17:00'
wednesday:
active: true
from: '9:00'
to: '17:00'
portScheduleId: string
name:
description: The name for your port schedule. Required.
type: str
networkId:
description: NetworkId path parameter. Network ID.
type: str
portSchedule:
description: The schedule for switch port scheduling. Schedules are applied to days
of the week. When it's empty, default schedule with all days of a week are configured.
Any unspecified day in the schedule is added as a default schedule configuration
of the day.
suboptions:
friday:
description: The schedule object for Friday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
monday:
description: The schedule object for Monday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
saturday:
description: The schedule object for Saturday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
sunday:
description: The schedule object for Sunday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
thursday:
description: The schedule object for Thursday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
tuesday:
description: The schedule object for Tuesday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
wednesday:
description: The schedule object for Wednesday.
suboptions:
active:
description: Whether the schedule is active (true) or inactive (false) during
the time specified between 'from' and 'to'. Defaults to true.
type: bool
from:
description: The time, from '00 00' to '24 00'. Must be less than the time
specified in 'to'. Defaults to '00 00'. Only 30 minute increments are allowed.
type: str
to:
description: The time, from '00 00' to '24 00'. Must be greater than the time
specified in 'from'. Defaults to '24 00'. Only 30 minute increments are
allowed.
type: str
type: dict
type: dict
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
portScheduleId:
description: PortScheduleId path parameter. Port schedule ID.
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"\
string\",\n \"portSchedule\": {\n \"friday\": {\n \"active\": true,\n\
\ \"from\": \"string\",\n \"to\": \"string\"\n },\n \"monday\"\
: {\n \"active\": true,\n \"from\": \"string\",\n \"to\": \"string\"\
\n },\n \"saturday\": {\n \"active\": true,\n \"from\": \"string\"\
,\n \"to\": \"string\"\n },\n \"sunday\": {\n \"active\": true,\n\
\ \"from\": \"string\",\n \"to\": \"string\"\n },\n \"thursday\"\
: {\n \"active\": true,\n \"from\": \"string\",\n \"to\": \"string\"\
\n },\n \"tuesday\": {\n \"active\": true,\n \"from\": \"string\"\
,\n \"to\": \"string\"\n },\n \"wednesday\": {\n \"active\": true,\n\
\ \"from\": \"string\",\n \"to\": \"string\"\n }\n }\n}\n"
type: dict