cisco.dnac.sda_fabric_border_device 模块 – SDA Fabric 边界设备的资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在剧本中使用它,请指定:cisco.dnac.sda_fabric_border_device
。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 sda_fabric_border_device_v1 的别名
注意
此模块具有相应的 action 插件。
要求
以下是执行此模块的主机所需的条件。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
DeviceManagementIpAddress 查询参数。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
SDA Fabric 边界设备的有效负载。 |
|
与给定设备关联的边界优先级。边界优先级的允许范围为 1-9。较小的值表示较高的优先级。例如,优先级 1 比优先级 5 优先。默认优先级将设置为 10。 |
|
边界会话类型。 |
|
具有外部连接性的边界(注意,对于中转边界为 True,对于非中转边界为 False)。 选项
|
|
连接到互联网。 选项
|
|
已配置设备的管理 IP 地址。 |
|
SD-Access 结构中支持的设备角色。允许的角色是“Border_Node”、“Control_Plane_Nod……”例如“Border_Node”或“Border_Node”、“Control_Plane_Node”或“Border_Node”、“Control_Plane_Node”、“Edge_Node”。 |
|
外部连接 IP 池名称。 |
|
SDA Fabric 边界设备的 externalConnectivitySettings。 |
|
外部自治系统编号对等体(例如,1-65535)。 |
|
接口描述。 |
|
接口名称。 |
|
SDA Fabric 边界设备的 l2Handoff。 |
|
与 Fabric 站点关联的虚拟网络名称。 |
|
L2 交接的 VLAN 名称。 |
|
SDA Fabric 边界设备的 l3Handoff。 |
|
SDA Fabric 边界设备的 virtualNetwork。 |
|
与 Fabric 站点关联的虚拟网络名称。 |
|
VLAN ID(例如,2-4096,但保留 VLAN(1002-1005、2046、4095)除外)。 |
|
外部域路由协议名称。 |
|
内部自治系统编号。 |
|
控制平面设备的路由分发协议。允许的值为“LISP_BGP”或“LISP_PUB_SUB”。默认值为“LISP_BGP”。 |
|
SD-Access 中转网络名称。 |
|
已配置设备的站点名称层次结构(站点应是 Fabric 站点的一部分)。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文的标志。 选项
|
备注
注意
使用的 SDK 方法为 sda.Sda.adds_border_device、sda.Sda.deletes_border_device,
使用的路径为 post /dna/intent/api/v1/business/sda/border-device、delete /dna/intent/api/v1/business/sda/border-device,
需要注意的是,此模块是 sda_fabric_border_device_v1 的别名
不支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
参见
另见
- Cisco DNA Center 文档,关于 SDA AddBorderDeviceInSDAFabricV1。
AddBorderDeviceInSDAFabricV1 API 的完整参考。
- Cisco DNA Center 文档,关于 SDA DeleteBorderDeviceFromSDAFabricV1。
DeleteBorderDeviceFromSDAFabricV1 API 的完整参考。
示例
- name: Create
cisco.dnac.sda_fabric_border_device:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
payload:
- borderPriority: string
borderSessionType: string
borderWithExternalConnectivity: true
connectedToInternet: true
deviceManagementIpAddress: string
deviceRole:
- string
externalConnectivityIpPoolName: string
externalConnectivitySettings:
- externalAutonomouSystemNumber: string
interfaceDescription: string
interfaceName: string
l2Handoff:
- virtualNetworkName: string
vlanName: string
l3Handoff:
- virtualNetwork:
virtualNetworkName: string
vlanId: string
externalDomainRoutingProtocolName: string
internalAutonomouSystemNumber: string
routeDistributionProtocol: string
sdaTransitNetworkName: string
siteNameHierarchy: string
- name: Delete all
cisco.dnac.sda_fabric_border_device:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: absent
deviceManagementIpAddress: string
返回值
常见的返回值已在此处记录,以下是此模块特有的字段:
键 |
描述 |
---|---|
Cisco DNAC Python SDK 返回的响应的字典或列表。 返回值:始终返回 示例: |