ieisystem.inmanage.edit_kvm 模块 – 设置 KVM

注意

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

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

要安装它，请使用：ansible-galaxy collection install ieisystem.inmanage。要使用此模块，您需要其他依赖项，有关详细信息，请参见需求。

要在剧本中使用它，请指定：ieisystem.inmanage.edit_kvm。

ieisystem.inmanage 1.0.0 中的新增功能

概要 

在 ieisystem 服务器上设置 KVM。

需求 

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

Python 3.7+
inManage

参数 

参数	注释
automatic_off 字符串	启动 KVM 时自动关闭服务器监控。选项 `"启用"` `"禁用"`
client_type 字符串	客户端类型。只有 M6 型号支持此参数。选项 `"vnc"` `"viewer"`
host 字符串	指定通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。
keyboard_language 字符串	选择键盘语言。 AD 为自动检测，DA 为丹麦语，NL-BE 为比利时荷兰语，NL-NL 为荷兰语。 GB 为英国英语，US 为美国英语，FI 为芬兰语，FR-BE 为比利时法语，FR 为法国法语。 DE 为德国德语，DE-CH 为瑞士德语，IT 为意大利语，JP 为日语。 NO 为挪威语，PT 为葡萄牙语，ES 为西班牙语，SV 为瑞典语，TR_F 为土耳其语 F，TR_Q 为土耳其语 Q。选项 `"AD"` `"DA"` `"NL-BE"` `"NL-NL"` `"GB"` `"US"` `"FI"` `"FR-BE"` `"FR"` `"DE"` `"DE-CH"` `"IT"` `"JP"` `"ON"` `"PT"` `"EC"` `"SV"` `"TR_F"` `"TR_Q"`
kvm_encryption 字符串	加密 KVM 数据包。选项 `"启用"` `"禁用"`
local_monitor_off 字符串	服务器监控关闭功能状态。选项 `"启用"` `"禁用"`
media_attach 字符串	提供两种类型的虚拟机附加模式。 Attach 为启动时立即将虚拟介质附加到服务器。 Auto 为仅在启动虚拟介质会话时才将虚拟介质附加到服务器。只有 M5 型号支持此参数。选项 `"attach"` `"auto"`
non_secure 字符串	启用/禁用非安全连接类型。只有 M6 型号支持此参数。当 client_type=vnc 时需要。选项 `"启用"` `"禁用"`
password 字符串	指定用于对远程设备连接进行身份验证的密码。如果任务中未指定该值，则将改用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
provider 字典	包含连接详细信息的字典对象。
host 字符串	指定通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。
password 字符串	指定用于对远程设备连接进行身份验证的密码。如果任务中未指定该值，则将改用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
username 字符串	配置用于对远程设备连接进行身份验证的用户名。如果任务中未指定该值，则将改用环境变量 `ANSIBLE_NET_USERNAME` 的值。
retry_count 整数	如果 KVM 失败，则重试的次数。重试次数范围为 1 到 20。只有 M5 型号支持此参数。
retry_time_interval 整数	重试时间间隔配置标识 (5-30) 秒。只有 M5 型号支持此参数。
ssh_vnc 字符串	启用/禁用 BMC 中的 SSH 上的 VNC。只有 M6 型号支持此参数。当 client_type=vnc 时需要。选项 `"启用"` `"禁用"`
stunnel_vnc 字符串	启用/禁用 BMC 中的 Stunnel 上的 VNC。只有 M6 型号支持此参数。当 client_type=vnc 时需要。选项 `"启用"` `"禁用"`
username 字符串	配置用于对远程设备连接进行身份验证的用户名。如果任务中未指定该值，则将改用环境变量 `ANSIBLE_NET_USERNAME` 的值。

备注 

注意

不支持 check_mode。

示例 

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

  tasks:

  - name: "Set KVM"
    ieisystem.inmanage.edit_kvm:
      kvm_encryption: "enable"
      media_attach: "auto"
      keyboard_language: "AD"
      retry_count: 13
      retry_time_interval: 10
      local_monitor_off: "enable"
      automatic_off: "enable"
      provider: "{{ inmanage }}"

返回值 

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

键	描述
changed 布尔值	检查设备上是否进行了更改。返回：始终
message 字符串	模块执行后返回的消息。返回：始终
state 字符串	模块执行后的状态。返回：始终

作者

王宝山 (@ieisystem)