kaytus.ksmanage.edit_media_instance module – Set Virtual Media Instance

Note

This module is part of the kaytus.ksmanage 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 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_media_instance.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set Virtual Media Instance on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

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.

kvm_num_cd

integer

Select the number of Remote KVM CD/DVD devices that support for virtual Media redirection.

The max support number of html5 KVM is 2 and java KVM is 4.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

kvm_num_fd

integer

Select the number of Remote KVM floppy devices that support for Virtual Media redirection.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

kvm_num_hd

integer

Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

num_cd

integer

Select the number of CD/DVD devices that support for Virtual Media redirection.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

num_fd

integer

Select the number of floppy devices that support for Virtual Media redirection.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

num_hd

integer

Select the number of harddisk devices that support for Virtual Media redirection.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

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.

power_save_mode

string

Check this option to enable Power Save Mode in BMC.

Choices:

  • "Enable"

  • "Disable"

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.

sd_media

string

Check this option to enable SD Media support in BMC.

Choices:

  • "Enable"

  • "Disable"

secure_channel

string

Check this option to enable encrypt media recirection packets.

Only the M5/M6 model supports this parameter.

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: Media instance test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set media instance"
    kaytus.ksmanage.edit_media_instance:
      num_fd: 1
      num_cd: 1
      num_hd: 1
      kvm_num_fd: 1
      kvm_num_cd: 1
      kvm_num_hd: 1
      sd_media: "Enable"
      secure_channel: "Enable"
      power_save_mode: "Enable"
      provider: "{{ ksmanage }}"

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)