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

inspur.sm.edit_virtual_media – Set virtual media.

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_virtual_media.

New in version 0.1.0: of inspur.sm

Synopsis

  • Set virtual media 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.
local_media_support
string
    Choices:
  • Enable
  • Disable
To enable or disable Local Media Support,check or uncheck the checkbox respectively.
Only the M5 model supports this parameter.
mount
string
    Choices:
  • Enable
  • Disable
Whether to mount virtual media.
mount_type
string
    Choices:
  • CD
  • FD
  • HD
Virtual mount type.
The FD option is not supported in M6.
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.
remote_domain_name
string
Remote Domain Name,Domain Name field is optional.
remote_media_support
string
    Choices:
  • Enable
  • Disable
To enable or disable Remote Media support,check or uncheck the checbox respectively.
remote_password
string
Remote Password.
Required when remote_share_type=cifs.
remote_server_address
string
Address of the server where the remote media images are stored.
remote_share_type
string
    Choices:
  • nfs
  • cifs
Share Type of the remote media server either NFS or Samba(CIFS).
remote_source_path
string
Source path to the remote media images..
remote_user_name
string
Remote User Name.
Required when remote_share_type=cifs.
same_settings
integer
    Choices:
  • 0
  • 1
Same settings with CD,0 is No,1 is Yes.
Required when mount_type=0.
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 test
  hosts: ism
  no_log: true
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set local media"
    inspur.sm.edit_virtual_media:
      local_media_support: "Enable"
      provider: "{{ ism }}"

  - name: "Set remote media"
    inspur.sm.edit_virtual_media:
      remote_media_support: "Enable"
      mount_type: 0
      same_settings: 0
      mount: "Enable"
      remote_server_address: "100.2.28.203"
      remote_source_path: "/data/nfs/server/"
      remote_share_type: "nfs"
      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_virtual_media_module.html