cisco.intersight.intersight_virtual_media_policy 模块 – Cisco Intersight 的虚拟媒体策略配置

注意

此模块是 cisco.intersight 集合（版本 2.0.20）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.intersight。

要在 playbook 中使用它，请指定：cisco.intersight.intersight_virtual_media_policy。

概要

• Cisco Intersight 的虚拟媒体策略配置。

• 用于在 Cisco Intersight 管理的设备上配置虚拟媒体映像映射。

• 有关更多信息，请参阅 Cisco Intersight。

参数

参数	注释
api_key_id 字符串 / 必需	与私钥关联的公共 API 密钥 ID。 如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。
api_private_key 路径 / 必需	PEM 格式的私钥数据的文件名（绝对路径）或字符串，用于 Intersight API 身份验证。 如果使用字符串，则应使用 Ansible Vault 加密字符串数据。 例如 ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <您的私钥数据> —–END EC PRIVATE KEY—–’ 如果未设置，则使用 INTERSIGHT_API_PRIVATE_KEY 环境变量的值。
api_uri 字符串	用于访问 Intersight API 的 URI。 如果未设置，则使用 INTERSIGHT_API_URI 环境变量的值。 默认值: "https://intersight.com/api/v1"
cdd_virtual_media 字典	CDD 虚拟媒体映像映射选项。
authentication_protocol 字符串	CIFS 挂载类型的身份验证协议 默认值: "none"
enable 布尔值	启用或禁用 CDD 映像映射。 选择 false true ← (默认)
mount_options 字符串	虚拟媒体映射的挂载选项。 对于 NFS，支持的选项为 ro、rw、nolock、noexec、soft、port=VALUE、timeo=VALUE、retry=VALUE 对于 CIFS，支持的选项为 soft、nounix、noserverino、guest
mount_type 字符串 / 必需	remote_hostname 使用的网络共享的类型（协议）。 确保可从托管端点访问您选择的挂载类型remote_hostname 的通信端口。 对于 CIFS 作为您的挂载类型，请确保 remote_hostname 上的端口 445（它是其通信端口）是可访问的。 对于 HTTP，请确保端口 80 是可访问的。 对于 HTTPS，请确保端口 443 是可访问的。 对于 NFS，请确保端口 2049 是可访问的。 选择 "nfs" "cifs" "http" "https"
password 字符串	如果需要，则为所选用户名设置的密码。
remote_file 字符串 / 必需	远程映像的文件名。 例如 custom_image.iso
remote_hostname 字符串 / 必需	托管虚拟媒体映像的服务器的主机名或 IP 地址。
remote_path 字符串 / 必需	远程映像的文件路径（不包括文件名）。 例如 mnt/SHARE/ISOS
username 字符串	如果需要，则为指定的挂载类型设置的用户名。
volume 字符串 / 必需	为映射安装的映像的用户定义名称。
description 别名: descr 字符串	用户定义的 NTP 策略描述。 描述可以包含字母 (a-z、A-Z)、数字 (0-9)、连字符 (-)、句点 (.)、冒号 (:) 或下划线 (_)。
enable 布尔值	启用或禁用虚拟媒体。 选择 false true ← (默认)
encryption 布尔值	如果启用，则允许加密所有虚拟媒体通信 选择 false ← (默认) true
hdd_virtual_media 字典	HDD 虚拟媒体映像映射选项。
authentication_protocol 字符串	CIFS 挂载类型的身份验证协议 默认值: "none"
enable 布尔值	启用或禁用 HDD 映像映射。 选择 false true ← (默认)
mount_options 字符串	虚拟媒体映射的挂载选项。 对于 NFS，支持的选项为 ro、rw、nolock、noexec、soft、port=VALUE、timeo=VALUE、retry=VALUE 对于 CIFS，支持的选项为 soft、nounix、noserverino、guest
mount_type 字符串 / 必需	remote_hostname 使用的网络共享的类型（协议）。 确保可从托管端点访问您选择的挂载类型remote_hostname 的通信端口。 对于 CIFS 作为您的挂载类型，请确保 remote_hostname 上的端口 445（它是其通信端口）是可访问的。 对于 HTTP，请确保端口 80 是可访问的。 对于 HTTPS，请确保端口 443 是可访问的。 对于 NFS，请确保端口 2049 是可访问的。 选择 "nfs" "cifs" "http" "https"
password 字符串	如果需要，则为所选用户名设置的密码。
remote_file 字符串 / 必需	远程映像的文件名。 例如 custom_image.iso
remote_hostname 字符串 / 必需	托管虚拟媒体映像的服务器的主机名或 IP 地址。
remote_path 字符串 / 必需	远程映像的文件路径（不包括文件名）。 例如 mnt/SHARE/ISOS
username 字符串	如果需要，则为指定的挂载类型设置的用户名。
volume 字符串 / 必需	为映射安装的映像的用户定义名称。
low_power_usb 布尔值	如果启用，则在映射映像并重新启动主机后，虚拟驱动器将显示在启动选择菜单中。 选择 false true ← (默认)
name 字符串 / 必需	分配给 NTP 策略的名称。 名称必须介于 1 到 62 个字母数字字符之间，允许特殊字符 :-_。
organization 字符串	此资源分配到的组织的名称。 在自定义组织中创建的配置文件和策略仅适用于同一组织中的设备。 默认值: "default"
state 字符串	如果为 present，将验证资源是否存在，并在需要时创建。 如果为 absent，将验证资源是否不存在，并在需要时删除。 选择 "present" ← (默认) "absent"
tags 列表 / 元素=字典	Key:<用户定义的键> Value:<用户定义的值> 格式的标签列表。
use_proxy 布尔值	如果为 no，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选择 false true ← (默认)
validate_certs 布尔值	用于验证 api_uri TLS 证书的布尔值控制 选择 false true ← (默认)

示例

- 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

返回值

常见的返回值记录在此处，以下是此模块独有的字段

键	描述
api_repsonse 字典	指定资源返回的 API 响应输出。 已返回: 始终 示例: {"api_response": {"Name": "lab-ntp", "ObjectType": "ntp.Policy", "Tags": [{"Key": "Site", "Value": "RCDN"}]}}

作者

• David Soper (@dsoper2)

• Sid Nath (@SidNath21)

集合链接

• 问题跟踪器
• 存储库 (源代码)