cisco.mso.mso_schema_template_bd 模块 – 在模式模板中管理桥接域 (BD)

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.mso。您需要满足其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：cisco.mso.mso_schema_template_bd。

概要

  • 在 Cisco ACI 多站点上管理模式模板中的 BD。

要求

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

  • 多站点编排器 v2.1 或更高版本

参数

参数

注释

arp_flooding

布尔值

ARP 泛洪

选项

  • false

  • true

bd

别名：name

字符串

要管理的 BD 的名称。

description

字符串

BD 的描述在 3.3 或更高版本的 MSO 上受支持。

dhcp_policies

列表 / 元素=字典

要与 BD 关联的 DHCP 策略列表

此选项仅可在 3.1.1h 或更高版本的 MSO 上使用。

dhcp_option_policy

字典

DHCP 选项策略

name

字符串 / 必需

DHCP 选项策略的名称

version

整数 / 必需

DHCP 选项策略的版本

name

字符串 / 必需

DHCP 中继策略的名称

version

整数 / 必需

DHCP 中继策略的版本

dhcp_policy

字典

DHCP 策略

dhcp_option_policy

字典

DHCP 选项策略

name

字符串 / 必需

DHCP 选项策略的名称

version

整数 / 必需

DHCP 选项策略的版本

name

字符串 / 必需

DHCP 中继策略的名称

version

整数 / 必需

DHCP 中继策略的版本

display_name

字符串

在 MSO Web 界面上显示的名称。

host

别名：hostname

字符串

ACI 多站点编排器主机的 IP 地址或主机名。

如果任务中未指定此值，则将使用环境变量 MSO_HOST 的值。

intersite_bum_traffic

布尔值

是否允许站点间 BUM 流量。

选项

  • false

  • true

ipv6_unknown_multicast_flooding

字符串

IPv6 未知组播泛洪可以是泛洪或优化泛洪

选项

  • "flood"

  • "optimized_flooding"

layer2_stretch

布尔值

是否启用 L2 扩展。

选项

  • false

  • true ← (默认)

layer2_unknown_unicast

字符串

二层未知单播。

选项

  • "flood"

  • "proxy"

layer3_multicast

布尔值

是否启用 L3 组播。

选项

  • false

  • true

login_domain

字符串

用于身份验证的登录域名称。

默认值为 Local。

如果任务中未指定此值，则将使用环境变量 MSO_LOGIN_DOMAIN 的值。

使用 HTTPAPI 连接插件时，如果未指定此属性，将使用清单变量 ansible_httpapi_login_domain。

multi_destination_flooding

字符串

多目标泛洪可以是在 BD 中泛洪、丢弃或在封装中泛洪。

在封装中泛洪仅在 3.3 或更高版本的 MSO 上受支持。

选项

  • "flood_in_bd"

  • "drop"

  • "encap-flood"

multicast_route_map_destination_filter

字符串

路由映射目标过滤器的名称。

路由映射目标过滤器必须与与模式关联的租户位于相同的租户中。

仅当 BD 启用了三层组播时才能使用此选项。

multicast_route_map_source_filter

字符串

路由映射源过滤器的名称。

路由映射源过滤器必须与与模式关联的租户位于相同的租户中。

仅当 BD 启用了三层组播时才能使用此选项。

optimize_wan_bandwidth

布尔值

是否优化广域网带宽。

选项

  • false

  • true

output_level

字符串

影响此 MSO 模块的输出。

normal 表示标准输出，包括 current 字典

info 添加信息输出，包括 previous、proposed 和 sent 字典

debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息

如果任务中未指定值，则将使用环境变量 MSO_OUTPUT_LEVEL 的值。

选项

  • "debug"

  • "info"

  • "normal" ← (默认)

密码

字符串

用于身份验证的密码。

如果任务中未指定值，则将使用环境变量 MSO_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。

端口

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

如果任务中未指定值，则将使用环境变量 MSO_PORT 的值。

模式

字符串 / 必需

模式名称。

状态

字符串

使用 present 或 absent 来添加或删除。

使用 query 来列出单个对象或多个对象。

选项

  • "absent"

  • "present" ← (默认)

  • "query"

子网

列表 / 元素=字典

与该 BD 关联的子网。

description

字符串

该子网的描述。

no_default_gateway

布尔值

该子网是否具有默认网关。

选项

  • false ← (默认)

  • true

主子网

布尔值

将此子网视为主子网。

在 BD 下的每个地址族中只能有一个主子网。

此选项仅可在 3.1.1h 或更高版本的 MSO 上使用。

选项

  • false ← (默认)

  • true

查询器

布尔值

该子网是否为 IGMP 查询器。

选项

  • false ← (默认)

  • true

范围

字符串

子网的范围。

选项

  • "private" ← (默认)

  • "public"

共享

布尔值

该子网是否在 VRF 之间共享。

选项

  • false ← (默认)

  • true

子网

别名：ip

字符串 / 必需

CIDR 表示法中的 IP 范围。

虚拟

布尔值

将此 IP 地址视为虚拟 IP 地址。

选项

  • false ← (默认)

  • true

模板

字符串 / 必需

模板名称。

操作的模板显示名称仅可在某些版本的 mso 中使用。

为了避免差异，请使用模板名称而不是显示名称。

超时

整数

以秒为单位的套接字级别超时。

默认值为 30 秒。

如果任务中未指定值，则将使用环境变量 MSO_TIMEOUT 的值。

单播路由

布尔值

单播路由

此选项仅可在 3.1.1h 或更高版本的 MSO 上使用。

选项

  • false

  • true

未知组播泛洪

字符串

未知组播泛洪可以是泛洪或优化泛洪。

选项

  • "flood"

  • "optimized_flooding"

使用代理

布尔值

如果为 false，即使目标主机上的环境变量中定义了代理，也不会使用代理。

如果任务中未指定值，则将使用环境变量 MSO_USE_PROXY 的值。

默认为 true。

选项

  • false

  • true

使用 SSL

布尔值

如果为 false，将使用 HTTP 连接而不是默认的 HTTPS 连接。

如果任务中未指定值，则将使用环境变量 MSO_USE_SSL 的值。

当使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 ansible_httpapi_use_ssl。

使用 HTTPAPI 连接插件 (mso 或 nd) 时默认为 false，使用旧版连接方法 (仅适用于 mso) 时默认为 true。

选项

  • false

  • true

用户名

字符串

用于身份验证的用户名。

如果任务中未指定值，则将使用环境变量 MSO_USERNAME 或 ANSIBLE_NET_USERNAME 的值。

验证证书

布尔值

如果为 false，则不会验证 SSL 证书。

仅在使用自签名证书的个人控制站点上才应将其设置为 false。

如果任务中未指定值，则将使用环境变量 MSO_VALIDATE_CERTS 的值。

默认为 true。

选项

  • false

  • true

虚拟MAC地址

字符串

虚拟MAC地址

VRF

字典

与该 BD 关联的 VRF。仅在创建新的 BD 时才需要此参数。

name

字符串 / 必需

要关联的 VRF 的名称。

模式

字符串

定义引用的 VRF 的模式。

如果未指定此参数，则默认为当前模式。

模板

字符串

定义引用的 VRF 的模板。

如果未指定此参数，则默认为当前模板。

注释

注意

  • 此模块编写用于支持 Multi Site Orchestrator v2.1 或更高版本。某些或所有功能可能在早期版本上不起作用。

示例

- name: Add a new BD
  cisco.mso.mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    vrf:
      name: VRF1
    state: present

- name: Add a new BD from another Schema
  mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    vrf:
      name: VRF1
      schema: Schema Origin
      template: Template Origin
    state: present

- name: Add bd with options available on version 3.1
  mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    intersite_bum_traffic: true
    optimize_wan_bandwidth: false
    layer2_stretch: true
    layer2_unknown_unicast: flood
    layer3_multicast: false
    unknown_multicast_flooding: flood
    multi_destination_flooding: drop
    ipv6_unknown_multicast_flooding: flood
    arp_flooding: false
    virtual_mac_address: 00:00:5E:00:01:3C
    subnets:
      - subnet: 10.0.0.128/24
      - subnet: 10.0.1.254/24
        description: 1234567890
      - ip: 192.168.0.254/24
        description: "My description for a subnet"
        scope: private
        shared: false
        no_default_gateway: true
    vrf:
      name: vrf1
      schema: Test
      template: Template1
    dhcp_policy:
      name: ansible_test
      version: 1
      dhcp_option_policy:
        name: ansible_test_option
        version: 1
    state: present

- name: Add bd with options available on version 3.1.1h or greater
  mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    intersite_bum_traffic: true
    optimize_wan_bandwidth: false
    layer2_stretch: true
    layer2_unknown_unicast: flood
    layer3_multicast: false
    unknown_multicast_flooding: flood
    multi_destination_flooding: drop
    ipv6_unknown_multicast_flooding: flood
    arp_flooding: false
    virtual_mac_address: 00:00:5E:00:01:3C
    unicast_routing: true
    subnets:
      - subnet: 10.0.0.128/24
        primary: true
      - subnet: 10.0.1.254/24
        description: 1234567890
        virtual: true
      - ip: 192.168.0.254/24
        description: "My description for a subnet"
        scope: private
        shared: false
        no_default_gateway: true
    vrf:
      name: vrf1
      schema: Schema1
      template: Template1
    dhcp_policies:
      - name: ansible_test
        version: 1
        dhcp_option_policy:
          name: ansible_test_option
          version: 1
      - name: ansible_test2
        version: 1
        dhcp_option_policy:
          name: ansible_test_option2
          version: 1
      - name: ansible_test3
        version: 1
        dhcp_option_policy:
          name: ansible_test_option
          version: 1
    state: present

- name: Remove a BD
  cisco.mso.mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD1
    state: absent

- name: Query a specific BD
  cisco.mso.mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD1
    state: query
  register: query_result

- name: Query all BDs
  cisco.mso.mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    state: query
  register: query_result

作者

  • Dag Wieers (@dagwieers)

  • Shreyas Srish (@shrsr)