cisco.aci.aci_vmm_vswitch_policy 模块 – 管理 VMware 虚拟域配置文件的 vSwitch 策略 (vmm:VSwitchPolicyCont)

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.aci。

要在 playbook 中使用它，请指定：cisco.aci.aci_vmm_vswitch_policy。

概要

• 管理 Cisco ACI 架构上 VMware VMM 域的 vSwitch 策略。

参数

参数	注释
annotation string	用户定义的字符串，用于注释对象。 如果任务中未指定该值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定该值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
cdp_policy string	结构访问 CDP 策略的名称。
certificate_name 别名：cert_name string	附加到用于基于签名身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此默认值为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此默认值为 username 值。 如果任务中未指定该值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
domain 别名：domain_name, domain_profile string	虚拟域配置文件的名称。
enhanced_lag list / elements=dictionary	如果 vSwitch 需要通过 VPC 连接，则为增强型 LAG 策略的列表。
lacp_mode string	LACP 端口通道模式。 选项 "active" "passive"
load_balancing_mode string	端口通道的负载平衡模式。 另请参阅 https://pubhub.devnetcloud.com/media/apic-mim-ref-421/docs/MO-lacpEnhancedLagPol.html。 选项 "dst-ip" "dst-ip-l4port" "dst-ip-vlan" "dst-ip-l4port-vlan" "dst-mac" "dst-l4port" "src-ip" "src-ip-l4port" "src-ip-vlan" "src-ip-l4port-vlan" "src-mac" "src-l4port" "src-dst-ip" "src-dst-ip-l4port" "src-dst-ip-vlan" "src-dst-ip-l4port-vlan" "src-dst-mac" "src-dst-l4port" "src-port-id" "vlan"
name string / required	增强型 Lag 策略的名称。
number_uplinks integer	上行链路的数量，必须介于 2 和 8 之间。
host 别名：hostname string	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
lldp_policy string	结构访问 LLDP 策略的名称。
mtu_policy string	仅限 VMWare。 结构访问 MTU 策略的名称。
netflow_exporter dictionary	netflow 导出器策略的参数
active_flow_timeout integer	指定在活动流启动后，NetFlow 等待发送收集的数据的延迟秒数。 范围是 60 到 3600。默认值为 60
idle_flow_timeout integer	指定在空闲流启动后，NetFlow 等待发送收集的数据的延迟秒数。 范围是 10 到 600。默认值为 15。
name string / required	netflow 导出器策略的名称
sampling_rate integer	（仅限 VDS）指定 NetFlow 在每个收集的数据包之后将丢弃多少个数据包。如果您指定值 0，则 NetFlow 不会丢弃任何数据包。 范围是 0 到 1000。默认值为 0。
output_level string	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息性输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug"（调试） "info"（信息） "normal" ← (默认)
output_path string	将用于转储模块生成的 ACI JSON 配置对象的文件路径。 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
owner_key string	ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个密钥，用于使客户端能够拥有其数据以进行实体关联。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_KEY 的值。
owner_tag string	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，用于使客户端能够添加自己的数据。 例如，指示谁创建了这个对象。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_TAG 的值。
password string	用于身份验证的密码。 此选项与 private_key 互斥。如果同时提供了 private_key，则将使用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port integer	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
port_channel_policy string	Fabric 访问端口通道策略的名称。
private_key 别名: cert_key string	用于基于签名身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响所使用的默认 certificate_name。 此选项与 password 互斥。如果同时提供了 password，则将忽略它。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
state string	使用 present 或 absent 来添加或删除。 使用 query 来列出一个对象或多个对象。 选项 "absent"（不存在） "present" ← (默认) "query"（查询）
stp_policy string	仅限 SCVMM。 STP 策略的名称。
suppress_previous 别名: no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查之前的值。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致之前返回的值为空。 不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false（假） true（真）
suppress_verification 别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新之后，不会发送验证 GET 请求。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 在单个任务中，包括默认值的当前对象将无法验证。 选项 false（假） true（真）
timeout integer	套接字级别超时（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy 布尔值	如果为 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false（假） true（真）
use_ssl 布尔值	如果为 false，将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选项 false（假） true（真）
username 别名: user string	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false（假） true（真）
vm_provider string	VMM 域的 VM 平台。 ACI v3.0 中添加了对 Kubernetes 的支持。 ACI v3.1 中添加了对 CloudFoundry、OpenShift 和 Red Hat 的支持。 选项 "cloudfoundry"（CloudFoundry） "kubernetes"（Kubernetes） "microsoft"（微软） "openshift"（OpenShift） "openstack"（OpenStack） "redhat"（红帽） "vmware"（VMware）

另请参阅

另请参阅

cisco.aci.aci_domain

管理物理、虚拟、桥接、路由或 FC 域配置文件（phys:DomP、vmm:DomP、l2ext:DomP、l3ext:DomP 和 fc:DomP）。

APIC 管理信息模型参考

有关内部 APIC 类 vmm:VSwitchPolicyCont 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础设施的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例

- name: Add a vSwitch policy with LLDP
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    lldp_policy: LLDP_ENABLED
    domain: vmware_dom
    vm_provider: vmware
    state: present

- name: Add a vSwitch policy with link aggregation
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel_policy: LACP_ACTIVE
    lldp_policy: LLDP_ENABLED
    domain: vmware_dom
    vm_provider: vmware
    enhanced_lag:
      - name: my_lacp_uplink
        lacp_mode: active
        load_balancing_mode: src-dst-ip
        number_uplinks: 2
    state: present

- name: Remove vSwitch Policy from VMware VMM domain
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    vm_provider: vmware
    state: absent

- name: Query the vSwitch policy of the VMWare domain
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    vm_provider: vmware
    state: query
  delegate_to: localhost
  register: query_result

返回值

常见的返回值在此处记录 这里，以下是此模块独有的字段

键	描述
current（当前） list / elements=string	模块完成后来自 APIC 的现有配置 返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error（错误） dictionary	从 APIC 返回的错误信息 返回: 失败 示例: {"code": "122", "text": "未知的托管对象类 foo"}
filter_string（过滤器字符串） string	用于请求的过滤器字符串 返回: 失败或调试 示例: "?rsp-prop-include=config-only"
method（方法） string	用于向 APIC 发出请求的 HTTP 方法 返回: 失败或调试 示例: "POST"
previous（先前） list / elements=string	模块启动之前来自 APIC 的原始配置 返回: 信息 示例: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
提议的 dictionary	由用户提供的参数组装的配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始的 string	APIC REST API 返回的原始输出 (xml 或 json) 返回: 解析错误 示例: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
响应 string	来自 APIC 的 HTTP 响应 返回: 失败或调试 示例: "OK (30 bytes)"
已发送 list / elements=string	推送到 APIC 的实际/最小配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 integer	来自 APIC 的 HTTP 状态 返回: 失败或调试 示例: 200
URL string	用于向 APIC 发出请求的 HTTP URL 返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Manuel Widmer (@lumean)

• Anvitha Jain (@anvitha-jain)

集合链接

• 问题跟踪器
• 仓库 (源代码)