528 lines
34 KiB
ReStructuredText
528 lines
34 KiB
ReStructuredText
.. Document meta
|
|
|
|
:orphan:
|
|
|
|
.. Anchors
|
|
|
|
.. _ansible_collections.inspur.sm.edit_kvm_module:
|
|
|
|
.. Anchors: short name for ansible.builtin
|
|
|
|
.. Anchors: aliases
|
|
|
|
|
|
|
|
.. Title
|
|
|
|
inspur.sm.edit_kvm -- Set KVM.
|
|
++++++++++++++++++++++++++++++
|
|
|
|
.. Collection note
|
|
|
|
.. note::
|
|
This plugin is part of the `inspur.sm collection <https://galaxy.ansible.com/inspur/sm>`_.
|
|
|
|
To install it use: :code:`ansible-galaxy collection install inspur.sm`.
|
|
|
|
To use it in a playbook, specify: :code:`inspur.sm.edit_kvm`.
|
|
|
|
.. version_added
|
|
|
|
.. versionadded:: 0.1.0 of inspur.sm
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
.. Deprecated
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. Description
|
|
|
|
- Set KVM on Inspur server.
|
|
|
|
.. Aliases
|
|
|
|
|
|
.. Requirements
|
|
|
|
|
|
.. Options
|
|
|
|
Parameters
|
|
----------
|
|
|
|
.. raw:: html
|
|
|
|
<table border=0 cellpadding=0 class="documentation-table">
|
|
<tr>
|
|
<th colspan="2">Parameter</th>
|
|
<th>Choices/<font color="blue">Defaults</font></th>
|
|
<th width="100%">Comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-automatic_off"></div>
|
|
<b>automatic_off</b>
|
|
<a class="ansibleOptionLink" href="#parameter-automatic_off" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Automatically OFF Server Monitor, When KVM Launches.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-client_type"></div>
|
|
<b>client_type</b>
|
|
<a class="ansibleOptionLink" href="#parameter-client_type" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>vnc</li>
|
|
<li>viewer</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Client Type.</div>
|
|
<div>Only the M6 model supports this parameter.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
|
<b>host</b>
|
|
<a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-keyboard_language"></div>
|
|
<b>keyboard_language</b>
|
|
<a class="ansibleOptionLink" href="#parameter-keyboard_language" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>AD</li>
|
|
<li>DA</li>
|
|
<li>NL-BE</li>
|
|
<li>NL-NL</li>
|
|
<li>GB</li>
|
|
<li>US</li>
|
|
<li>FI</li>
|
|
<li>FR-BE</li>
|
|
<li>FR</li>
|
|
<li>DE</li>
|
|
<li>DE-CH</li>
|
|
<li>IT</li>
|
|
<li>JP</li>
|
|
<li>ON</li>
|
|
<li>PT</li>
|
|
<li>EC</li>
|
|
<li>SV</li>
|
|
<li>TR_F</li>
|
|
<li>TR_Q</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Select the Keyboard Language.</div>
|
|
<div>AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland,</div>
|
|
<div>GB is English UK ,US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France,</div>
|
|
<div>DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese,</div>
|
|
<div>NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR_F is Turkish F, TR_Q is Turkish Q.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-kvm_encryption"></div>
|
|
<b>kvm_encryption</b>
|
|
<a class="ansibleOptionLink" href="#parameter-kvm_encryption" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Encrypt KVM packets.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-local_monitor_off"></div>
|
|
<b>local_monitor_off</b>
|
|
<a class="ansibleOptionLink" href="#parameter-local_monitor_off" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Server Monitor OFF Feature Status.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-media_attach"></div>
|
|
<b>media_attach</b>
|
|
<a class="ansibleOptionLink" href="#parameter-media_attach" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>attach</li>
|
|
<li>auto</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Two types of VM attach mode are available.</div>
|
|
<div>Attach is Immediately attaches Virtual Media to the server upon bootup.</div>
|
|
<div>Auto is Attaches Virtual Media to the server only when a virtual media session is started.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-non_secure"></div>
|
|
<b>non_secure</b>
|
|
<a class="ansibleOptionLink" href="#parameter-non_secure" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Enable/disable Non Secure Connection Type.</div>
|
|
<div>Only the M6 model supports this parameter.</div>
|
|
<div>Required when <em>client_type=vnc</em>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
|
<b>password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider"></div>
|
|
<b>provider</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">dictionary</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>A dict object containing connection details.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
|
|
<b>host</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
|
|
<b>password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
|
|
<b>username</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-retry_count"></div>
|
|
<b>retry_count</b>
|
|
<a class="ansibleOptionLink" href="#parameter-retry_count" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">integer</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-retry_time_interval"></div>
|
|
<b>retry_time_interval</b>
|
|
<a class="ansibleOptionLink" href="#parameter-retry_time_interval" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">integer</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>The Identification for retry time interval configuration (5-30) seconds.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-ssh_vnc"></div>
|
|
<b>ssh_vnc</b>
|
|
<a class="ansibleOptionLink" href="#parameter-ssh_vnc" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Enable/disable VNC over SSH in BMC.</div>
|
|
<div>Only the M6 model supports this parameter.</div>
|
|
<div>Required when <em>client_type=vnc</em>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-stunnel_vnc"></div>
|
|
<b>stunnel_vnc</b>
|
|
<a class="ansibleOptionLink" href="#parameter-stunnel_vnc" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>enable</li>
|
|
<li>disable</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Enable/disable VNC over Stunnel in BMC.</div>
|
|
<div>Only the M6 model supports this parameter.</div>
|
|
<div>Required when <em>client_type=vnc</em>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
|
<b>username</b>
|
|
<a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br/>
|
|
|
|
.. Notes
|
|
|
|
|
|
.. Seealso
|
|
|
|
|
|
.. Examples
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
|
|
- 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 }}"
|
|
|
|
|
|
|
|
|
|
.. Facts
|
|
|
|
|
|
.. Return values
|
|
|
|
Return Values
|
|
-------------
|
|
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
|
|
|
|
.. raw:: html
|
|
|
|
<table border=0 cellpadding=0 class="documentation-table">
|
|
<tr>
|
|
<th colspan="1">Key</th>
|
|
<th>Returned</th>
|
|
<th width="100%">Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-changed"></div>
|
|
<b>changed</b>
|
|
<a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">boolean</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Check to see if a change was made on the device.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-message"></div>
|
|
<b>message</b>
|
|
<a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Messages returned after module execution.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-state"></div>
|
|
<b>state</b>
|
|
<a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Status after module execution.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br/><br/>
|
|
|
|
.. Status (Presently only deprecated)
|
|
|
|
|
|
.. Authors
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- WangBaoshan (@ISIB-group)
|
|
|
|
|
|
|
|
.. Parsing errors
|
|
|