Docs4dev
Docs
ansible / latest / collections / inspur / sm / edit_media_instance_module.html

inspur.sm.edit_media_instance – Set Virtual Media Instance

Note

This plugin is part of the inspur.sm collection (version 1.3.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 inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_media_instance.

New in version 0.1.0: of inspur.sm

Synopsis

  • Set Virtual Media Instance on Inspur server.

Parameters

Parameter Choices/Defaults 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
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
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.
kvm_num_fd
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
Select the number of Remote KVM floppy devices that support for Virtual Media redirection.
kvm_num_hd
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection.
num_cd
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
Select the number of CD/DVD devices that support for Virtual Media redirection.
num_fd
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
Select the number of floppy devices that support for Virtual Media redirection.
num_hd
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
Select the number of harddisk devices that support for Virtual Media redirection.
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
    Choices:
  • Enable
  • Disable
Check this option to enable Power Save Mode in BMC.
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
    Choices:
  • Enable
  • Disable
Check this option to enable SD Media support in BMC.
secure_channel
string
    Choices:
  • Enable
  • Disable
Check this option to enable encrypt media recirection packets.
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: Media instance test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set media instance"
    inspur.sm.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: "{{ 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/latest/collections/inspur/sm/edit_media_instance_module.html