cisco.intersight.intersight_boot_order_policy module – Boot Order policy configuration for Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.0.20).
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 cisco.intersight
.
To use it in a playbook, specify: cisco.intersight.intersight_boot_order_policy
.
Synopsis
Boot Order policy configuration for Cisco Intersight.
Used to configure Boot Order servers and timezone settings on Cisco Intersight managed devices.
For more information see Cisco Intersight.
Parameters
Parameter |
Comments |
---|---|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <your private key data> —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
List of Boot Devices configured on the endpoint. |
|
Details of the bootloader to be used during boot from local disk. Option is used when device_type is local_disk and configured_boot_mode is Uefi. Default: |
|
Details of the bootloader to be used during boot from local disk. Option is used when device_type is local_disk and configured_boot_mode is Uefi. Default: |
|
Details of the bootloader to be used during boot from local disk. Option is used when device_type is local_disk and configured_boot_mode is Uefi. Default: |
|
The slot id of the controller for the local disk device. Option is used when device_type is local_disk. Choices:
|
|
A name that helps identify a boot device. It can be any string that adheres to the following constraints. It should start and end with an alphanumeric character. It can have underscores and hyphens. It cannot be more than 30 characters. |
|
Device type used with this boot option. Choices are based on each device title in the API schema. Choices:
|
|
Specifies if the boot device is enabled or disabled. Choices:
|
|
The name of the underlying virtual ethernet interface used by the PXE boot device. Option is used when device_type is pxe and interface_source is name. |
|
Lists the supported Interface Source for PXE device. Option is used when device_type is pxe. Choices:
|
|
The IP Address family type to use during the PXE Boot process. Option is used when device_type is pxe. Choices:
|
|
The Logical Unit Number (LUN) of the device. Option is used when device_type is pch, san and sd_card. The LUN need to be an integer from 0 to 255. |
|
The MAC Address of the underlying virtual ethernet interface used by the PXE boot device. Option is used when device_type is pxe and interface_source is mac. |
|
The slot id of the controller for the iscsi and pxe device. Option is used when device_type is iscsi and pxe. Choices:
|
|
The port id of the controller for the iscsi and pxe device. Option is used when device_type is iscsi and pxe. The port id need to be an integer from 0 to 255. |
|
The subtype for the selected device type. Option is used when device_type is sd_card. Choices:
|
|
The subtype for the selected device type. Option is used when device_type is usb. Choices:
|
|
The subtype for the selected device type. Option is used when device_type is virtual_media. Choices:
|
|
Sets the BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the Master Boot Record (MBR) partitioning scheme. Choices:
|
|
The user-defined description of the Boot Order policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
The name assigned to the Boot Order policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
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. Default: |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
Secure boot enforces that device boots using only software that is trusted by the Original Equipment Manufacturer (OEM). Option is only used if configured_boot_mode is set to Uefi. Choices:
|
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The API response output returned by the specified resource. Returned: always Sample: |