inspur.sm.edit_kvm – Set KVM.
Note
This plugin is part of the inspur.sm collection (version 1.1.2).
To install it use: ansible-galaxy collection install inspur.sm.
To use it in a playbook, specify: inspur.sm.edit_kvm.
New in version 0.1.0: of inspur.sm
Synopsis
- Set KVM on Inspur server.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| automatic_off string |
| Automatically OFF Server Monitor, When KVM Launches. | |
| host string | 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. | ||
| keyboard_language string |
| 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. | |
| kvm_encryption string |
| Encrypt KVM packets. | |
| local_monitor_off string |
| Server Monitor OFF Feature Status. | |
| media_attach string |
| 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. | |
| password string | 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 ANSIBLE_NET_PASSWORD will be used instead. | ||
| provider dictionary | A dict object containing connection details. | ||
| host string | 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. | ||
| password string | 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 ANSIBLE_NET_PASSWORD will be used instead. | ||
| username string | 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 ANSIBLE_NET_USERNAME will be used instead. | ||
| retry_count integer | Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20. | ||
| retry_time_interval integer | The Identification for retry time interval configuration (5-30) seconds. | ||
| username string | 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 ANSIBLE_NET_USERNAME will be used instead. | ||
Examples
- name: KVM test
hosts: ism
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set KVM"
inspur.sm.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: "{{ ism }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed boolean | always | Check to see if a change was made on the device. |
| message string | always | Messages returned after module execution. |
| state string | always | Status after module execution. |
Authors
- WangBaoshan (@ISIB-group)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/inspur/sm/edit_kvm_module.html