cisco.aci.aci_access_port_block_to_access_port 模块 – 管理 Fabric 接入 Leaf/Spine 接口端口选择器（infra:PortBlk）的端口块

注意

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

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

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

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

概要 

管理 Cisco ACI Fabric 上 Fabric 接入接口 Leaf/Spine 端口选择器的端口块。

参数 

参数	注释
access_port_selector 别名: name, access_port_selector_name 字符串	Fabric 接入策略 Leaf/Spine 接口端口选择器的名称。
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` 的值。
from_card 别名: from_card_range 字符串	端口块的卡范围块的起始（起始范围）。
from_port 别名: from, fromPort, from_port_range 字符串	端口块的端口范围块的起始（起始范围）。
host 别名: hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定该值，则将改用环境变量 `ACI_HOST` 的值。
interface_profile 别名: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name, spine_interface_profile, spine_interface_profile_name 字符串	Fabric 接入策略 Leaf/Spine 接口配置文件的名称。
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` 的值。
密码字符串	用于身份验证的密码。此选项与 `private_key` 互斥。如果也提供了 `private_key`，则将使用它。如果任务中未指定该值，则将使用环境变量 `ACI_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定该值，则将使用环境变量 `ACI_PORT` 的值。
port_blk 别名: leaf_port_blk_name, leaf_port_blk 字符串	Fabric 访问策略接口端口块的名称。
port_blk_description 别名: leaf_port_blk_description 字符串	端口块的描述。
private_key 别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式私钥文件或私钥内容。此值还会影响所使用的默认 `certificate_name`。此选项与 `password` 互斥。如果也提供了 `password`，则将忽略它。如果任务中未指定该值，则将使用环境变量 `ACI_PRIVATE_KEY` 或 `ANSIBLE_NET_SSH_KEYFILE` 的值。
状态字符串	使用 `present` 或 `absent` 添加或删除。使用 `query` 列出一个或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
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。
to_card 别名: to_card_range 字符串	端口块的卡范围块的结束（to-range）。
to_port 别名: to, toPort, to_port_range 字符串	端口块的端口范围块的结束（to-range）。
类型字符串	要在各自的访问端口下创建的端口块的类型。选择 `"fex"` `"leaf"` ← (默认) `"spine"`
use_proxy 布尔值	如果为 `false`，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定该值，则将使用环境变量 `ACI_USE_PROXY` 的值。默认值为 true。选择 `false` `true`
use_ssl 布尔值	如果为 `false`，则将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定该值，则将使用环境变量 `ACI_USE_SSL` 的值。当连接为本地连接时，默认值为 true。选择 `false` `true`
username 别名: user 字符串	用于身份验证的用户名。如果任务中未指定该值，则将使用环境变量 `ACI_USERNAME` 或 `ANSIBLE_NET_USERNAME` 的值。默认值为 admin。
validate_certs 布尔值	如果为 `false`，则不会验证 SSL 证书。仅当在个人控制的站点上使用自签名证书时，才应将其设置为 `false`。如果任务中未指定该值，则将使用环境变量 `ACI_VALIDATE_CERTS` 的值。默认值为 true。选择 `false` `true`

注释 

注意

如果在类型为 leaf 的访问叶接口端口选择器上添加端口块，则必须在 playbook 中使用此模块之前存在interface_profile和access_port_selector。可以使用 cisco.aci.aci_interface_policy_leaf_profile 和 cisco.aci.aci_access_port_to_interface_policy_leaf_profile 模块。
如果在 type 为 spine 的访问接口端口选择器上添加端口块，则必须在 playbook 中使用此模块之前存在 interface_profile 和 access_port_selector。可以使用 cisco.aci.aci_access_spine_interface_profile 和 cisco.aci.aci_access_spine_interface_selector 模块。

另请参阅 

另请参阅

cisco.aci.aci_interface_policy_leaf_profile: 管理 Fabric 接口策略叶配置文件 (infra:AccPortP)。
cisco.aci.aci_access_port_to_interface_policy_leaf_profile: 管理 Fabric 接口策略叶配置文件接口选择器 (infra:HPortS、infra:RsAccBaseGrp 和 infra:PortBlk)。
cisco.aci.aci_access_spine_interface_profile: 管理 Fabric 接口策略主干配置文件 (infra:SpAccPortP)。
cisco.aci.aci_access_spine_interface_selector: 管理 Fabric 访问策略主干接口端口选择器 (infra:SHPortS)。
APIC 管理信息模型参考: 有关内部 APIC 类 **infra:PortBlk** 的更多信息。
Cisco ACI 指南: 有关如何使用 Ansible 管理 ACI 基础架构的详细信息。
开发 Cisco ACI 模块: 有关如何编写自己的 Cisco ACI 模块以做出贡献的详细指南。

示例 

- name: Associate a Fabric access policy interface port block (single port) to an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

- name: Associate a Fabric access policy interface port block (port range) to an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 16
    state: present
  delegate_to: localhost

- name: Associate a Fabric access policy interface port block (single port) to an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

- name: Associate a Fabric access policy interface port block (port range) to an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 16
    state: present
  delegate_to: localhost

- name: Query Specific Fabric access policy interface port block under given access port selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Specific Fabric access policy interface port block under given access port selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks under given leaf interface profile
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks under given leaf interface profile of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks in the fabric
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks in the fabric of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Fabric access policy interface port block from an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: absent
  delegate_to: localhost

- name: Remove a Fabric access policy interface port block from an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 13
    state: absent
  delegate_to: localhost

返回值 

常用返回值在此处记录 here，以下是此模块特有的字段

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

作者

Simon Metzger (@smnmtzgr)
Gaspard Micol (@gmicol)