ieisystem.inmanage.del_session 模块 – 删除会话

注意

此模块是 ieisystem.inmanage 集合(版本 3.0.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install ieisystem.inmanage。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:ieisystem.inmanage.del_session

ieisystem.inmanage 1.0.0 中的新增功能

概要

  • 删除 ieisystem 服务器上的会话。

要求

执行此模块的主机需要满足以下要求。

  • Python 3.7+

  • inManage

参数

参数

注释

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。

password

字符串

指定用于验证与远程设备连接的密码。如果未在任务中指定该值,则将改用环境变量 ANSIBLE_NET_PASSWORD 的值。

provider

字典

包含连接详细信息的字典对象。

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。

password

字符串

指定用于验证与远程设备连接的密码。如果未在任务中指定该值,则将改用环境变量 ANSIBLE_NET_PASSWORD 的值。

username

字符串

配置用于验证与远程设备连接的用户名。如果未在任务中指定该值,则将改用环境变量 ANSIBLE_NET_USERNAME 的值。

sid

字符串 / 必需

会话 ID,输入“all”删除所有会话。

username

字符串

配置用于验证与远程设备连接的用户名。如果未在任务中指定该值,则将改用环境变量 ANSIBLE_NET_USERNAME 的值。

注意

注意

  • 不支持 check_mode

示例

- name: Delete session test
  hosts: inmanage
  connection: local
  gather_facts: false
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Delete session"
    ieisystem.inmanage.del_session:
      sid: "223"
      provider: "{{ inmanage }}"

返回值

常见的返回值记录在 此处,以下是此模块特有的字段

描述

changed

布尔值

检查设备上是否进行了更改。

返回: 总是

message

字符串

模块执行后返回的消息。

返回: 总是

state

字符串

模块执行后的状态。

返回: 总是

作者

  • WangBaoshan (@ieisystem)