cisco.aci.aci_access_spine_switch_selector 模块 – 管理 Fabric 访问策略 Spine 交换机端口选择器 (infra:SpineS)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中的 Fabric 访问策略 Spine 交换机端口选择器。

参数

参数	注释
注释 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改用环境变量 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 的值。
描述 字符串	Spine 交换机端口选择器的描述。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 ACI_HOST 的值。
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 的值。
password 字符串	用于身份验证的密码。 此选项与private_key互斥。如果也提供了private_key，则将优先使用它。 如果任务中未指定此值，则将改用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
policy_group 别名：policy_group_name 字符串	要与Spine交换机端口选择器关联的Fabric接入策略组的名称。
port 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定此值，则将改用环境变量ACI_PORT的值。
private_key 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果任务中未指定此值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
selector_type 别名：type 字符串	主机端口选择器类型。 如果使用端口块来指定交换机范围，则类型必须设置为range。 选项 "all" "range"
spine_switch_profile 别名：spine_switch_profile_name, switch_profile, switch_profile_name 字符串	Fabric接入策略Spine交换机配置文件的名称。
spine_switch_selector 别名：name, spine_switch_selector_name, switch_selector, switch_selector_name, access_port_selector, access_port_selector_name 字符串	Fabric接入Spine交换机端口选择器的名称。
state 字符串	使用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
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定此值，则将改用环境变量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 字符串	用于身份验证的用户名。 如果任务中未指定此值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
validate_certs 布尔值	如果为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上使用时，才应将其设置为false。 如果任务中未指定此值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true

注释

注意

• 在您的playbook中使用此模块之前，必须存在spine_switch_profile。cisco.aci.aci_access_spine_switch_profile模块可用于此目的。

• 如果使用policy_group，则在您的playbook中使用此模块之前，它必须存在。可以使用cisco.aci.aci_switch_policy_group模块。

另请参阅

另请参阅

cisco.aci.aci_access_spine_switch_profile

管理Fabric接入Spine交换机配置文件 (infra:SpineP)。

APIC管理信息模型参考

有关内部APIC类infra:SpineS和infra:RsAccNodePGrp的更多信息。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Add a switch policy spine profile selector (with policy group)
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    policy_group: somepolicygroupname
    state: present
  delegate_to: localhost

- name: Query a switch policy spine profile selector
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    state: query
  delegate_to: localhost

- name: Query all switch policy spine profile selectors
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a switch policy spine profile selector
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    state: absent
  delegate_to: localhost

返回值

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

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

作者

• Eric Girard (@netgirard)

• Gaspard Micol (@gmicol)

资源链接

• 问题跟踪
• 代码仓库