cisco.intersight.intersight_virtual_media_policy – Virtual Media policy configuration for Cisco Intersight

Note

This plugin is part of the cisco.intersight collection (version 1.0.9).

To install it use: ansible-galaxy collection install cisco.intersight.

To use it in a playbook, specify: cisco.intersight.intersight_virtual_media_policy.

New in version 2.10: of cisco.intersight

Synopsis
Parameters
Examples
Return Values

Synopsis

Virtual Media policy configuration for Cisco Intersight.
Used to configure Virtual Media image mappings on Cisco Intersight managed devices.
For more information see Cisco Intersight.

Parameters

Parameter		Choices/Defaults	Comments
api_key_id string / required			Public API Key ID associated with the private key.
api_private_key path / required			Filename (absolute path) of a PEM formatted file that contains your private key to be used for Intersight API authentication.
api_uri string		Default: "https://intersight.com/api/v1%22	URI used to access the Intersight API.
cdd_virtual_media string			CDD Virtual Media image mapping options.
	enable boolean	no yes ←	Enable or disable CDD image mapping.
	mount_type string / required	nfs cifs http https	Type (protocol) of network share used by the remote_hostname. Ensure that the remote_hostname's communication port for the mount type that you choose is accessible from the managed endpoint. For CIFS as your mount type, ensure port 445 (which is its communication port) on the remote_hostname is accessible. For HTTP, ensure port 80 is accessible. For HTTPS, ensure port 443 is accessible. For NFS, ensure port 2049 is accessible.
	password string		The password for the selected username, if required.
	remote_file string / required		Filename of the remote image. Ex. custom_image.iso
	remote_hostname string / required		Hostname or IP address of the server hosting the virtual media image.
	remote_path string / required		Filepath (not including the filename) of the remote image. Ex. mnt/SHARE/ISOS
	username string		The username for the specified Mount Type, if required.
	volume string / required		A user defined name of the image mounted for mapping.
descrption string			The user-defined description of the NTP policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). aliases: descr
enable boolean		no yes ←	Enable or disable virtual media.
encryption boolean		no ← yes	If enabled, allows encryption of all Virtual Media communications
hdd_virtual_media string			HDD Virtual Media image mapping options.
	authentication_protocol string		Authentication Protocol for CIFS Mount Type
	enable boolean	no ← yes	Enable or disable HDD image mapping.
	mount_options string		Mount options for the Virtual Media mapping. For NFS, supported options are ro, rw, nolock, noexec, soft, port=VALUE, timeo=VALUE, retry=VALUE For CIFS, supported options are soft, nounix, noserverino, guest
	mount_type string / required	nfs cifs http https	Type (protocol) of network share used by the remote_hostname. Ensure that the remote_hostname's communication port for the mount type that you choose is accessible from the managed endpoint. For CIFS as your mount type, ensure port 445 (which is its communication port) on the remote_hostname is accessible. For HTTP, ensure port 80 is accessible. For HTTPS, ensure port 443 is accessible. For NFS, ensure port 2049 is accessible.
	password string		The password for the selected username, if required.
	remote_file string / required		Filename of the remote image. Ex. custom_image.iso
	remote_hostname string / required		Hostname or IP address of the server hosting the virtual media image.
	remote_path string / required		Filepath (not including the filename) of the remote image. Ex. mnt/SHARE/ISOS
	username string		The username for the specified Mount Type, if required.
	volume string / required		A user defined name of the image mounted for mapping.
low_power_usb boolean		no yes ←	If enabled, the virtual drives appear on the boot selection menu after mapping the image and rebooting the host.
name string / required			The name assigned to the NTP policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
organization string		Default: "default"	The name of the Organization this resource is assigned to. Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.
state string		present ← absent	If `present`, will verify the resource is present and will create if needed. If `absent`, will verify the resource is absent and will delete if needed.
tags list / elements=string			List of tags in Key: Value: format.
use_proxy boolean		no yes ←	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs boolean		no yes ←	Boolean control for verifying the api_uri TLS certificate

Examples

- name: Configure Virtual Media Policy
  cisco.intersight.intersight_virtual_media_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-vmedia
    description: Virutal Media policy for lab use
    tags:
      - Key: Site
        Value: RCDN
    cdd_virtual_media:
      mount_type: nfs
      volume: nfs-cdd
      remote_hostname: 172.28.224.77
      remote_path: mnt/SHARE/ISOS/CENTOS
      remote_file: CentOS7.iso
    hdd_virtual_media:
      mount_type: nfs
      volume: nfs-hdd
      remote_hostname: 172.28.224.77
      remote_path: mnt/SHARE/ISOS/CENTOS
      remote_file: CentOS7.iso

- name: Delete Virtual Media Policy
  cisco.intersight.intersight_virtual_media_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-vmedia
    state: absent

Return Values

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

Key	Returned	Description
api_repsonse dictionary	always	The API response output returned by the specified resource. Sample: {'api_response': {'Name': 'lab-ntp', 'ObjectType': 'ntp.Policy', 'Tags': [{'Key': 'Site', 'Value': 'RCDN'}]}}

Authors

David Soper (@dsoper2)
Sid Nath (@SidNath21)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/intersight/intersight_virtual_media_policy_module.html