cisco.intersight.intersight_boot_order_policy 模块 – Cisco Intersight 的启动顺序策略配置

注意

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

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

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

要在剧本中使用它，请指定：cisco.intersight.intersight_boot_order_policy。

概要 

Cisco Intersight 的启动顺序策略配置。
用于在 Cisco Intersight 管理的设备上配置启动顺序服务器和时区设置。
更多信息请参见 Cisco Intersight。

参数 

参数	注释
api_key_id 字符串 / 必需	与私钥关联的公共 API 密钥 ID。如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。
api_private_key 路径 / 必需	用于 Intersight API 身份验证的 PEM 格式私钥数据的文件名（绝对路径）或字符串。如果使用字符串，则应使用 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"`
boot_devices 列表 / 元素=字典	在端点上配置的启动设备列表。
bootloader_description 字符串	从本地磁盘启动时要使用的引导加载程序的详细信息。当 device_type 为 local_disk 且 configured_boot_mode 为 Uefi 时使用此选项。默认值： `""`
bootloader_name 字符串	从本地磁盘启动时要使用的引导加载程序的详细信息。当 device_type 为 local_disk 且 configured_boot_mode 为 Uefi 时使用此选项。默认值： `""`
bootloader_path 字符串	从本地磁盘启动时要使用的引导加载程序的详细信息。当 device_type 为 local_disk 且 configured_boot_mode 为 Uefi 时使用此选项。默认值： `""`
controller_slot 字符串	本地磁盘设备的控制器的插槽 ID。当 device_type 为 local_disk 时使用此选项。选项 `"1-255"` `"M"` `"HBA"` `"SAS"` `"RAID"` `"MRAID"` `"MSTOR-RAID"`
device_name 字符串 / 必需	帮助标识启动设备的名称。它可以是符合以下约束的任何字符串。它应该以字母数字字符开头和结尾。它可以包含下划线和连字符。它不能超过 30 个字符。
device_type 字符串 / 必需	与此启动选项一起使用的设备类型。选项基于 API 模式中的每个设备标题。选项 `"iSCSI"` `"本地 CDD"` `"本地磁盘"` `"NVMe"` `"PCH 存储"` `"PXE"` `"SAN"` `"SD 卡"` `"UEFI Shell"` `"USB"` `"虚拟介质"`
enabled 布尔值	指定启动设备是启用还是禁用。选项 `false` `true` ← (默认)
interface_name 字符串	PXE 启动设备使用的底层虚拟以太网接口的名称。当 device_type 为 pxe 且 interface_source 为 name 时使用此选项。
interface_source 字符串	列出 PXE 设备支持的接口源。当 device_type 为 pxe 时使用此选项。选项 `"name"` ← (默认) `"mac"` `"port"`
ip_type 字符串	在 PXE 启动过程中要使用的 IP 地址族类型。当 device_type 为 pxe 时使用此选项。选项 `"None"` ← (默认) `"IPv4"` `"IPv6"`
lun 整数	设备的逻辑单元号 (LUN)。当 device_type 为 pch、san 和 sd_card 时使用此选项。 LUN 必须是 0 到 255 之间的整数。
mac_address 字符串	PXE 启动设备使用的底层虚拟以太网接口的 MAC 地址。当 device_type 为 pxe 且 interface_source 为 mac 时使用此选项。
network_slot 字符串	iscsi 和 pxe 设备的控制器的插槽 ID。当 device_type 为 iscsi 和 pxe 时使用此选项。选项 `"1 - 255"` `"MLOM"` `"L"` `"L1"` `"L2"` `"OCP"`
port 整数	iscsi 和 pxe 设备的控制器的端口 ID。当 device_type 为 iscsi 和 pxe 时使用此选项。端口 ID 必须是 0 到 255 之间的整数。
sd_card_subtype 字符串	所选设备类型的子类型。当 device_type 为 sd_card 时使用此选项。选项 `"None"` ← (默认) `"flex-util"` `"flex-flash"` `"SDCARD"`
usb_subtype 字符串	所选设备类型的子类型。当 device_type 为 usb 时使用此选项。选项 `"None"` ← (默认) `"usb-cd"` `"usb-fdd"` `"usb-hdd"`
virtual_media_subtype 字符串	所选设备类型的子类型。当 device_type 为 virtual_media 时使用此选项。选项 `"None"` ← (默认) `"cimc-mapped-dvd"` `"cimc-mapped-hdd"` `"kvm-mapped-dvd"` `"kvm-mapped-hdd"` `"kvm-mapped-fdd"`
configured_boot_mode 字符串	设置 BIOS 启动模式。 UEFI 使用 GUID 分区表 (GPT)，而传统模式使用主引导记录 (MBR) 分区方案。选项 `"Legacy"` ← (默认) `"Uefi"`
description 别名：descr 字符串	启动顺序策略的用户定义描述。描述可以包含字母 (a-z、A-Z)、数字 (0-9)、连字符 (-)、句点 (.)、冒号 (:) 或下划线 (_)。
name 字符串 / 必需	分配给启动顺序策略的名称。名称必须在 1 到 62 个字母数字字符之间，允许使用特殊字符 :-_。
organization 字符串	此资源分配到的组织的名称。在自定义组织中创建的配置文件和策略仅适用于同一组织中的设备。默认值： `"default"`
状态 (state) 字符串	如果 `present`，将验证资源是否存在，如果需要则创建。如果 `absent`，将验证资源是否不存在，如果需要则删除。选项 `"present"` ← (默认) `"absent"`
标签 (tags) 列表 / 元素=字典	键值对格式的标签列表：键:<用户自定义键> 值:<用户自定义值>
uefi_enable_secure_boot 布尔值	安全启动强制设备仅使用原始设备制造商 (OEM) 信任的软件启动。仅当 configured_boot_mode 设置为 Uefi 时才使用此选项。选项 `false` ← (默认) `true`
use_proxy 布尔值	如果 `no`，即使目标主机上的环境变量中定义了代理，也不会使用代理。选项 `false` `true` ← (默认)
validate_certs 布尔值	用于验证 api_uri TLS 证书的布尔值控制。选项 `false` `true` ← (默认)

示例 

- name: Configure Boot Order Policy
  cisco.intersight.intersight_boot_order_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: COS-Boot
    description: Boot Order policy for COS
    tags:
      - Key: Site
        Value: RCDN
    configured_boot_mode: legacy
    boot_devices:
      - device_type: Local Disk
        device_name: Boot-Lun
        controller_slot: MRAID

- name: Delete Boot Order Policy
  cisco.intersight.intersight_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: COS-Boot
    state: absent

返回值 

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

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

作者

陈凯（@BrightScale）

cisco.intersight.intersight_boot_order_policy 模块 – Cisco Intersight 的启动顺序策略配置

概要

参数

示例

返回值

作者

收集链接

概要 

参数 

示例 

返回值 