ieisystem.inmanage.edit_kvm module – Set KVM

Note

This module is part of the ieisystem.inmanage collection (version 2.0.0).

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 ieisystem.inmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ieisystem.inmanage.edit_kvm.

New in ieisystem.inmanage 1.0.0

Synopsis

  • Set KVM on ieisystem Server.

Requirements

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

automatic_off

string

Automatically OFF Server Monitor, When KVM Launches.

Choices:

  • "enable"

  • "disable"

client_type

string

Client Type.

Only the M6 model supports this parameter.

Choices:

  • "vnc"

  • "viewer"

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.

Choices:

  • "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

string

Encrypt KVM packets.

Choices:

  • "enable"

  • "disable"

local_monitor_off

string

Server Monitor OFF Feature Status.

Choices:

  • "enable"

  • "disable"

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.

Only the M5 model supports this parameter.

Choices:

  • "attach"

  • "auto"

non_secure

string

Enable/disable Non Secure Connection Type.

Only the M6 model supports this parameter.

Required when client_type=vnc.

Choices:

  • "enable"

  • "disable"

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.

Only the M5 model supports this parameter.

retry_time_interval

integer

The Identification for retry time interval configuration (5-30) seconds.

Only the M5 model supports this parameter.

ssh_vnc

string

Enable/disable VNC over SSH in BMC.

Only the M6 model supports this parameter.

Required when client_type=vnc.

Choices:

  • "enable"

  • "disable"

stunnel_vnc

string

Enable/disable VNC over Stunnel in BMC.

Only the M6 model supports this parameter.

Required when client_type=vnc.

Choices:

  • "enable"

  • "disable"

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.

Notes

Note

  • Does not support check_mode.

Examples

- 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 }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ieisystem)