cisco.meraki.networks_appliance_prefixes_delegated_statics 模块 – 网络设备 _前缀 _委托 _静态资源模块

注意

此模块是 cisco.meraki 集合(版本 2.18.3)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.meraki.networks_appliance_prefixes_delegated_statics

cisco.meraki 2.16.0 中的新功能

概要

  • 管理资源网络 _设备 _前缀 _委托 _静态的创建、更新和删除操作。

  • 从网络添加静态委托前缀。

  • 从网络删除静态委托前缀。

  • 从网络更新静态委托前缀。

注意

此模块具有相应的 action 插件

要求

执行此模块的主机需要以下要求。

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

description

string

前缀的名称或描述。

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer),操作批处理并发错误重试等待时间

默认值: 60

meraki_api_key

string / 必需

meraki_api_key (string),仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string),所有端点资源的前缀

默认值: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID

默认值: ""

meraki_caller

string

meraki_caller (string),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER

默认值: ""

meraki_certificate_path

string

meraki_certificate_path (string),如果位于本地代理后面,则用于 TLS/SSL 证书验证的路径

默认值: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean),继承您自己的记录器实例

选项

  • false ← (默认)

  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string),日志文件名附加日期和时间戳

默认值: "meraki_api_"

meraki_log_path

string

log_path (string),输出日志的路径;默认情况下,如果未指定,则为脚本的工作目录

默认值: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer),遇到 429s 或其他服务器端错误时,最多重试此次数

默认值: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer),Nginx 429 重试等待时间

默认值: 60

meraki_output_log

boolean

meraki_output_log (boolean),创建输出日志文件?

选项

  • false

  • true ← (默认)

meraki_print_console

boolean

meraki_print_console (boolean),将日志输出打印到控制台?

选项

  • false

  • true ← (默认)

meraki_requests_proxy

string

meraki_requests_proxy (string),如果需要,用于 HTTPS 的代理服务器和端口

默认值: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean),如果遇到其他 4XX 错误(除了 429)是否重试?

选项

  • false ← (默认)

  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer),其他 4XX 错误重试等待时间

默认值: 60

meraki_simulate

boolean

meraki_simulate (boolean),模拟 POST/PUT/DELETE 调用以防止更改?

选项

  • false ← (默认)

  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer),每次 API 调用的最大秒数

默认值: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean),禁用所有日志记录?那您就靠自己了!

选项

  • false ← (默认)

  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表

选项

  • false ← (默认)

  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean),如果遇到 429 速率限制错误是否重试?

选项

  • false

  • true ← (默认)

networkId

string

NetworkId 路径参数。网络 ID。

origin

dictionary

前缀的来源。

interfaces

list / elements=string

与前缀关联的接口。

type

string

来源的类型。

prefix

string

静态 IPv6 前缀。

staticDelegatedPrefixId

string

StaticDelegatedPrefixId 路径参数。静态委托前缀 ID。

注意

注意

  • 使用的 SDK 方法是 appliance.Appliance.create_network_appliance_prefixes_delegated_static, appliance.Appliance.delete_network_appliance_prefixes_delegated_static, appliance.Appliance.update_network_appliance_prefixes_delegated_static,

  • 使用的路径是 post /networks/{networkId}/appliance/prefixes/delegated/statics, delete /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}, put /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId},

  • 不支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco Meraki 文档,了解 appliance createNetworkAppliancePrefixesDelegatedStatic

createNetworkAppliancePrefixesDelegatedStatic API 的完整参考。

Cisco Meraki 文档,了解 appliance deleteNetworkAppliancePrefixesDelegatedStatic

deleteNetworkAppliancePrefixesDelegatedStatic API 的完整参考。

Cisco Meraki 文档,了解 appliance updateNetworkAppliancePrefixesDelegatedStatic

updateNetworkAppliancePrefixesDelegatedStatic API 的完整参考。

示例

- name: Create
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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
    description: Prefix on WAN 1 of Long Island Office network
    networkId: string
    origin:
      interfaces:
      - wan1
      type: internet
    prefix: 2001:db8:3c4d:15::/64

- name: Delete by id
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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
    staticDelegatedPrefixId: string

- name: Update by id
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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
    description: Prefix on WAN 1 of Long Island Office network
    networkId: string
    origin:
      interfaces:
      - wan1
      type: internet
    prefix: 2001:db8:3c4d:15::/64
    staticDelegatedPrefixId: string

返回值

通用返回值记录在这里,以下是此模块特有的字段

描述

meraki_response

dictionary

一个字典或列表,包含 Cisco Meraki Python SDK 返回的响应

返回: 始终

示例: {}

作者

  • Francisco Munoz (@fmunoz)