kaytus.ksmanage.edit_kvm module – Set KVM
Note
This module is part of the kaytus.ksmanage collection (version 1.2.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install kaytus.ksmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: kaytus.ksmanage.edit_kvm
.
New in kaytus.ksmanage 1.0.0
Synopsis
Set KVM on kaytus Server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inManage
Parameters
Parameter |
Comments |
---|---|
Automatically OFF Server Monitor, When KVM Launches. Choices:
|
|
Client Type. Only the M6 model supports this parameter. Choices:
|
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Select the Keyboard Language. AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland. GB is English UK , US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France. DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese. NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR_F is Turkish F, TR_Q is Turkish Q. Choices:
|
|
Encrypt KVM packets. Choices:
|
|
Server Monitor OFF Feature Status. Choices:
|
|
Two types of VM attach mode are available. Attach is Immediately attaches Virtual Media to the server upon bootup. Auto is Attaches Virtual Media to the server only when a virtual media session is started. Only the M5 model supports this parameter. Choices:
|
|
Enable/disable Non Secure Connection Type. Only the M6 model supports this parameter. Required when client_type=vnc. Choices:
|
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
A dict object containing connection details. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20. Only the M5 model supports this parameter. |
|
The Identification for retry time interval configuration (5-30) seconds. Only the M5 model supports this parameter. |
|
Enable/disable VNC over SSH in BMC. Only the M6 model supports this parameter. Required when client_type=vnc. Choices:
|
|
Enable/disable VNC over Stunnel in BMC. Only the M6 model supports this parameter. Required when client_type=vnc. Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
Notes
Note
Does not support
check_mode
.
Examples
- name: KVM test
hosts: ksmanage
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set KVM"
kaytus.ksmanage.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: "{{ ksmanage }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |