cisco.ise.network_device 模块 – 网络设备资源模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.ise.network_device。
cisco.ise 1.0.0 中的新增功能
概要
管理网络设备资源的创建、更新和删除操作。
此 API 创建一个网络设备。
此 API 通过 ID 删除网络设备。
此 API 通过名称删除网络设备。
此 API 允许客户端通过 ID 更新网络设备。
此 API 允许客户端通过名称更新网络设备。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
网络设备的 authenticationSettings。 |
|
此值强制使用 DTLS。 选项
|
|
启用标志。 选项
|
|
EnableKeyWrap 标志。 选项
|
|
网络设备的 enableMultiSecret。 |
|
网络设备的 keyEncryptionKey。 |
|
允许的值 - ASCII, - HEXADECIMAL。 |
|
网络设备的 messageAuthenticatorCodeKey。 |
|
允许的值 - RADIUS, - TACACS_PLUS。 |
|
网络设备的 radiusSharedSecret。 |
|
网络设备的 secondRADIUSSharedSecret。 |
|
网络设备的 coaPort。 |
|
网络设备的描述。 |
|
此值用于验证 X.509 RADIUS/DTLS 客户端证书中包含的客户端身份。 |
|
网络设备的 ID。 |
|
用于 Identity Services Engine SDK 以启用调试的标志。 选项
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时时间（以秒为单位）。 默认值： |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选项
|
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Identity Services Engine。 默认值： |
|
用于 Identity Services Engine SDK 以启用自动速率限制处理的标志。 选项
|
|
网络设备的 modelName。 |
|
网络设备的名称。 |
|
此节点的网络设备组名称列表。 |
|
此节点的 IP 子网列表。 |
|
它可以是单个 IP 地址或 IP 范围地址。 |
|
网络设备的 IP 地址。 |
|
网络设备的掩码。可以是字符串，但将转换为整数。 |
|
网络设备的 profileName。 |
|
网络设备的 snmpsettings。 |
|
LinkTrapQuery 标志。 选项
|
|
MacTrapQuery 标志。 选项
|
|
网络设备的 originatingPolicyServicesNode。 |
|
网络设备的 pollingInterval。 |
|
网络设备的 roCommunity。 |
|
网络设备的版本。 |
|
网络设备的软件版本。 |
|
网络设备的 tacacsSettings。 |
|
允许的值 - OFF, - ON_LEGACY, - ON_DRAFT_COMPLIANT。 |
|
网络设备的 sharedSecret。 |
|
网络设备的 trustsecsettings。 |
|
网络设备的 deviceAuthenticationSettings。 |
|
网络设备的 sgaDeviceId。 |
|
网络设备的 sgaDevicePassword。 |
|
网络设备的 deviceConfigurationDeployment。 |
|
网络设备的 enableModePassword。 |
|
网络设备的 execModePassword。 |
|
网络设备的 execModeUsername。 |
|
IncludeWhenDeployingSGTUpdates 标志。 选项
|
|
PushIdSupport 标志。 选项
|
|
网络设备的 sgaNotificationAndUpdates。 |
|
网络设备的 coaSourceHost。 |
|
网络设备的 downlaodEnvironmentDataEveryXSeconds。 |
|
网络设备的downloadPeerAuthorizationPolicyEveryXSeconds。 |
|
网络设备的downloadSGACLListsEveryXSeconds。 |
|
OtherSGADevicesToTrustThisDevice标志。 选项
|
|
网络设备的reAuthenticationEveryXSeconds。 |
|
SendConfigurationToDevice标志。 选项
|
|
允许值 - ENABLE_USING_COA, - ENABLE_USING_CLI, - DISABLE_ALL。 |
注释
注意
使用的SDK方法为network_device.NetworkDevice.create_network_device, network_device.NetworkDevice.delete_network_device_by_id, network_device.NetworkDevice.delete_network_device_by_name, network_device.NetworkDevice.update_network_device_by_id, network_device.NetworkDevice.update_network_device_by_name,
使用的路径为post /ers/config/networkdevice, delete /ers/config/networkdevice/name/{name}, delete /ers/config/networkdevice/{id}, put /ers/config/networkdevice/name/{name}, put /ers/config/networkdevice/{id},
不支持
check_mode该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco ISE SDK的嵌入式连接管理器。
以ise_开头的参数由Cisco ISE Python SDK用于建立连接。
示例
- name: Update by name
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
id: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
- name: Delete by name
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
name: string
- name: Update by id
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
id: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
- name: Delete by id
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
返回值
常见的返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含Cisco ISE Python SDK返回的响应的字典或列表。 返回：始终 示例： |
|
包含Cisco ISE Python SDK返回的响应的字典或列表。 返回：始终 示例： |