cisco.aci.aci_vmm_controller 模块 – 管理虚拟域配置文件的 VMM 控制器 (vmm:CtrlrP)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的 vCenter 虚拟域。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也没有值，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
controller_hostname 字符串	控制器的主机名或 IP 地址。
credentials 字符串	要使用的 VMM 凭据的名称
datacenter 字符串	数据中心的名称，如在 vCenter 中所示
domain 别名：domain_name, domain_profile 字符串	虚拟域配置文件的名称。
dvs_version 字符串	VMware DVS 的版本。 选项 "unmanaged" "5.1" "5.5" "6.0" "6.5" "6.6" "7.0" "8.0"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
inband_management_epg 字符串	控制器要使用的管理 EPG 的名称。目前仅支持内带管理 EPG。
name 字符串	VMM 控制器的名称。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定此值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置对象的路径。 如果任务中未指定此值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定值，则将改用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
端口 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定值，则将改用环境变量ACI_PORT的值。
私钥 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将被忽略。 如果任务中未指定值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
状态 字符串	使用present或absent添加或删除。 使用query列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
统计信息收集 字符串	是否启用统计信息收集。 选项 "enabled" "disabled" ← (默认)
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
超时 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将改用环境变量ACI_TIMEOUT的值。 默认值为30。
使用代理 布尔值	如果为false，即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定值，则将改用环境变量ACI_USE_PROXY的值。 默认值为true。 选项 false true
使用SSL 布尔值	如果为false，将使用HTTP连接而不是默认的HTTPS连接。 如果任务中未指定值，则将改用环境变量ACI_USE_SSL的值。 连接为本地连接时，默认值为true。 选项 false true
用户名 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
验证证书 布尔值	如果为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上使用时，才应将其设置为false。 如果任务中未指定值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true
虚拟机提供商 字符串	VMM域的虚拟机平台。 ACI v3.0中添加了对Kubernetes的支持。 ACI v3.1中添加了对CloudFoundry、OpenShift和Red Hat的支持。 选项 "cloudfoundry" "kubernetes" "microsoft" "openshift" "openstack" "redhat" "vmware"

另请参阅

另请参阅

cisco.aci.aci_domain

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

cisco.aci.aci_vmm_credential

管理虚拟域凭据配置文件（vmm:UsrAccP）。

APIC管理信息模型参考

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

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Add controller to VMware VMM domain
  cisco.aci.aci_vmm_controller:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    name: vCenter1
    controller_hostname: 10.1.1.1
    dvs_version: unmanaged
    vm_provider: vmware
    credentials: vCenterCredentials1
    datacenter: DC1
    state: present

- name: Remove controller from VMware VMM domain
  cisco.aci.aci_vmm_controller:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    name: vCenter1
    vm_provider: vmware
    state: absent

- name: Query a specific VMware VMM controller
  cisco.aci.aci_vmm_controller:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    name: vCenter1
    vm_provider: vmware
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VMware VMM controller
  cisco.aci.aci_vmm_controller:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

公共返回值已在此处记录，以下是此模块特有的字段

键	描述
当前 列表 / 元素=字符串	模块完成后的APIC现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
过滤器字符串 字符串	用于请求的过滤器字符串 返回：失败或调试 示例："?rsp-prop-include=config-only"
方法 字符串	用于向APIC发送请求的HTTP方法 返回：失败或调试 示例："POST"
先前 列表 / 元素=字符串	模块启动前APIC的原始配置 返回：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议的 字典	从用户提供的参数组装的配置 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始的 字符串	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>"
响应 字符串	来自APIC的HTTP响应 返回：失败或调试 示例： "OK (30 bytes)"
已发送 列表 / 元素=字符串	实际/最小配置已推送到 APIC 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产 环境"}}}
状态 整数	APIC 返回的 HTTP 状态码 返回：失败或调试 示例： 200
URL 字符串	用于向 APIC 发送请求的 HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Manuel Widmer (@lumean)

• Anvitha Jain (@anvitha-jain)

• Akini Ross (@akinross)

资源链接

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