kaytus.ksmanage.del_session 模块 – 删除会话
注意
此模块是 kaytus.ksmanage 集合(版本 2.0.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install kaytus.ksmanage
。您需要进一步的要求才能使用此模块,有关详细信息,请参阅要求。
要在 Playbook 中使用它,请指定:kaytus.ksmanage.del_session
。
kaytus.ksmanage 1.0.0 中的新功能
概要
删除 kaytus 服务器上的会话。
要求
在执行此模块的主机上需要以下要求。
Python 3.7+
inManage
参数
参数 |
注释 |
---|---|
指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。 |
|
指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 |
|
包含连接详细信息的字典对象。 |
|
指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。 |
|
指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 |
|
配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 |
|
会话 ID,输入 “all” 删除所有会话。 |
|
配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 |
注意事项
注意
不支持
check_mode
。
示例
- name: Delete session test
hosts: ksmanage
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Delete session"
kaytus.ksmanage.del_session:
sid: "223"
provider: "{{ ksmanage }}"
返回值
常见的返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
检查设备是否进行了更改。 返回:总是 |
|
模块执行后返回的消息。 返回:总是 |
|
模块执行后的状态。 返回:总是 |