cisco.aci.aci_fabric_wide_settings 模块 – 管理 Fabric 范围设置 (infra:SetPol)

注意

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

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

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

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

概要 

管理 Cisco ACI Fabric 上的 Fabric 范围设置。

参数 

参数	注释
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` 的值。
disable_remote_ep_learning 布尔值	是否在包含外部桥接/路由域的 VRF 中禁用远程端点学习。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_domain_validation 布尔值	如果添加了静态路径但没有将域关联到 EPG，是否执行验证检查。请求域验证是一次性操作。启用后，无法禁用。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_epg_vlan_validation 布尔值	是否执行验证检查以防止将重叠的 VLAN 池关联到 EPG。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_subnet_check 布尔值	是否为所有 VRF 禁用在 VRF 中配置的子网外部的 IP 地址学习。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将使用环境变量 `ACI_HOST` 的值。
leaf_opflex_client_auth 布尔值	是否对叶交换机上的 GOLF 和 Linux 强制执行 Opflex 客户端证书身份验证。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
leaf_ssl_opflex 布尔值	是否为叶交换机启用 SSL Opflex 传输。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
opflex_ssl_versions 列表 / 元素=字符串	要为 Opflex 启用的 TLS 版本。设置任何 TLS 版本时，必须显式设置所有版本的 state。选项 `"tls_v1.0"` `"tls_v1.1"` `"tls_v1.2"`
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` 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的自定义字符串。此属性表示一个密钥，用于启用客户端拥有其数据以进行实体关联。如果任务中未指定值，则将使用环境变量 `ACI_OWNER_KEY` 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的自定义字符串。此属性表示一个标签，用于启用客户端添加自己的数据。例如，指示谁创建了此对象。如果任务中未指定值，则将改用环境变量`ACI_OWNER_TAG`的值。
密码字符串	用于身份验证的密码。此选项与`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`的值。
重新分配gipo 布尔值	是否重新分配一些非扩展BD gipo以腾出空间用于扩展BD。请求gipo重新分配是一次性操作。启用后，无法禁用。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
限制基础设施VLAN流量布尔值	是否将基础设施VLAN流量限制为仅指定的网络路径。这些启用的网络路径由基础设施安全条目策略定义。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
Spine Opflex客户端身份验证布尔值	是否对Spine交换机上的GOLF和Linux强制执行Opflex客户端证书身份验证。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
Spine SSL Opflex 布尔值	是否为Spine交换机启用SSL Opflex传输。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
状态字符串	使用`present`更新配置。使用`query`显示当前配置。选项 `"present"` ← (默认) `"query"`
抑制先前别名：no_previous, ignore_previous 布尔值	如果为`true`，则在向APIC发出POST更新之前不会发送GET以检查先前状态。如果任务中未指定值，则将改用环境变量`ACI_SUPPRESS_PREVIOUS`的值。默认值为`false`。警告 - 这会导致先前的返回值为空。不会检查对象的先前状态，并且POST更新将包含所有属性。选项 `false` `true`
抑制验证别名：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`

另请参见 

另请参见

APIC管理信息模型参考: 有关内部APIC类infra:SetPol的更多信息。
Cisco ACI指南: 有关如何使用Ansible管理ACI基础设施的详细信息。
开发Cisco ACI模块: 有关如何编写自己的Cisco ACI模块以进行贡献的详细指南。

示例 

- name: Update Fabric Wide Settings
  cisco.aci.aci_fabric_wide_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    disable_remote_ep_learning: true
    enforce_epg_vlan_validation: true
    state: present
  delegate_to: localhost

- name: Update Opflex SSL versions
  cisco.aci.aci_fabric_wide_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    opflex_ssl_versions: [tls_v1.2]
    state: present
  delegate_to: localhost

- name: Query Fabric Wide Settings
  cisco.aci.aci_fabric_wide_settings:
    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 字节)"`
已发送列表 / 元素=字符串	实际/最小配置已推送到 APIC 返回：信息示例： `{"fvTenant": {"attributes": {"descr": "生产环境"}}}`
状态整数	APIC 返回的 HTTP 状态码返回：失败或调试示例： `200`
URL 字符串	用于向 APIC 发出请求的 HTTP URL 返回：失败或调试示例： `"https://10.11.12.13/api/mo/uni/tn-production.json"`

作者

Tim Cragg (@timcragg)
Akini Ross (@akinross)

参数	注释
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` 的值。
disable_remote_ep_learning 布尔值	是否在包含外部桥接/路由域的 VRF 中禁用远程端点学习。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_domain_validation 布尔值	如果添加了静态路径但没有将域关联到 EPG，是否执行验证检查。请求域验证是一次性操作。启用后，无法禁用。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_epg_vlan_validation 布尔值	是否执行验证检查以防止将重叠的 VLAN 池关联到 EPG。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
enforce_subnet_check 布尔值	是否为所有 VRF 禁用在 VRF 中配置的子网外部的 IP 地址学习。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将使用环境变量 `ACI_HOST` 的值。
leaf_opflex_client_auth 布尔值	是否对叶交换机上的 GOLF 和 Linux 强制执行 Opflex 客户端证书身份验证。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
leaf_ssl_opflex 布尔值	是否为叶交换机启用 SSL Opflex 传输。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
opflex_ssl_versions 列表 / 元素=字符串	要为 Opflex 启用的 TLS 版本。设置任何 TLS 版本时，必须显式设置所有版本的 state。选项 `"tls_v1.0"` `"tls_v1.1"` `"tls_v1.2"`
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` 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的自定义字符串。此属性表示一个密钥，用于启用客户端拥有其数据以进行实体关联。如果任务中未指定值，则将使用环境变量 `ACI_OWNER_KEY` 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的自定义字符串。此属性表示一个标签，用于启用客户端添加自己的数据。例如，指示谁创建了此对象。如果任务中未指定值，则将改用环境变量`ACI_OWNER_TAG`的值。
密码字符串	用于身份验证的密码。此选项与`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`的值。
重新分配gipo 布尔值	是否重新分配一些非扩展BD gipo以腾出空间用于扩展BD。请求gipo重新分配是一次性操作。启用后，无法禁用。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
限制基础设施VLAN流量布尔值	是否将基础设施VLAN流量限制为仅指定的网络路径。这些启用的网络路径由基础设施安全条目策略定义。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
Spine Opflex客户端身份验证布尔值	是否对Spine交换机上的GOLF和Linux强制执行Opflex客户端证书身份验证。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
Spine SSL Opflex 布尔值	是否为Spine交换机启用SSL Opflex传输。在创建期间未设置时，APIC 默认值为 `true`。选项 `false` `true`
状态字符串	使用`present`更新配置。使用`query`显示当前配置。选项 `"present"` ← (默认) `"query"`
抑制先前别名：no_previous, ignore_previous 布尔值	如果为`true`，则在向APIC发出POST更新之前不会发送GET以检查先前状态。如果任务中未指定值，则将改用环境变量`ACI_SUPPRESS_PREVIOUS`的值。默认值为`false`。警告 - 这会导致先前的返回值为空。不会检查对象的先前状态，并且POST更新将包含所有属性。选项 `false` `true`
抑制验证别名：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`

cisco.aci.aci_fabric_wide_settings 模块 – 管理 Fabric 范围设置 (infra:SetPol)

概要

参数

另请参见

示例

返回值

作者

相关链接

概要 

参数 

另请参见 

示例 

返回值 