inspur.ispim.edit_connect_media module – Start/Stop virtual media Image

Note

This module is part of the inspur.ispim collection (version 2.2.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.ispim. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: inspur.ispim.edit_connect_media.

New in inspur.ispim 1.0.0

Synopsis 

Start/Stop virtual media Image on Inspur server.

Requirements 

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

Python 3.7+
inspursmsdk

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.
image_name string / required	Image name.
image_type string / required	Virtual media type. Only the M5 model supports this parameter. Choices: `"CD"` `"FD"` `"HD"`
op_type string / required	Start or stop media. Choices: `"start"` `"stop"`
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.
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: Connect media test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set remote image redirection"
    inspur.ispim.edit_connect_media:
      image_type: "CD"
      op_type: "start"
      image_name: "aa.iso"
      provider: "{{ ism }}"

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 (@ispim)

inspur.ispim.edit_connect_media module – Start/Stop virtual media Image

Synopsis

Requirements

Parameters

Notes

Examples

Return Values