Try SpotterBoot Order policy configuration for Cisco Intersight
Authors: Tse Kai "Kevin" Chan (@BrightScale)
preview | supported by community
Install with ansible-galaxy collection install cisco.intersight:==2.0.8
collections:
- name: cisco.intersight
version: 2.0.8Boot Order policy configuration for Cisco Intersight.
Used to configure Boot Order servers and timezone settings on Cisco Intersight managed devices.
For more information see L(Cisco Intersight,https://intersight.com/apidocs).
- 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
name:
description:
- The name assigned to the Boot Order policy.
- The name must be between 1 and 62 alphanumeric characters, allowing special characters
:-_.
required: true
type: str
tags:
description:
- List of tags in Key:<user-defined key> Value:<user-defined value> format.
elements: dict
type: list
state:
choices:
- present
- absent
default: present
description:
- If C(present), will verify the resource is present and will create if needed.
- If C(absent), will verify the resource is absent and will delete if needed.
type: str
api_uri:
default: https://intersight.com/api/v1
description:
- URI used to access the Intersight API.
- If not set, the value of the INTERSIGHT_API_URI environment variable is used.
type: str
use_proxy:
default: true
description:
- If C(no), it will not use a proxy, even if one is defined in an environment variable
on the target hosts.
type: bool
api_key_id:
description:
- Public API Key ID associated with the private key.
- If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.
required: true
type: str
description:
aliases:
- descr
description:
- 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(_).
type: str
boot_devices:
description:
- List of Boot Devices configured on the endpoint.
elements: dict
suboptions:
bootloader_description:
default: ''
description:
- 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.
type: str
bootloader_name:
default: ''
description:
- 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.
type: str
bootloader_path:
default: ''
description:
- 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.
type: str
controller_slot:
choices:
- 1-255
- M
- HBA
- SAS
- RAID
- MRAID
- MSTOR-RAID
description:
- The slot id of the controller for the local disk device.
- Option is used when device_type is local_disk.
type: str
device_name:
description:
- 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.
required: true
type: str
device_type:
choices:
- iSCSI
- Local CDD
- Local Disk
- NVMe
- PCH Storage
- PXE
- SAN
- SD Card
- UEFI Shell
- USB
- Virtual Media
description:
- Device type used with this boot option.
- Choices are based on each device title in the API schema.
required: true
type: str
enabled:
default: true
description:
- Specifies if the boot device is enabled or disabled.
type: bool
interface_name:
description:
- 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.
type: str
interface_source:
choices:
- name
- mac
- port
default: name
description:
- Lists the supported Interface Source for PXE device.
- Option is used when device_type is pxe.
type: str
ip_type:
choices:
- None
- IPv4
- IPv6
default: None
description:
- The IP Address family type to use during the PXE Boot process.
- Option is used when device_type is pxe.
type: str
lun:
description:
- 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.
type: int
mac_address:
description:
- 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.
type: str
network_slot:
choices:
- 1 - 255
- MLOM
- L
- L1
- L2
- OCP
description:
- The slot id of the controller for the iscsi and pxe device.
- Option is used when device_type is iscsi and pxe.
type: str
port:
description:
- 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.
type: int
sd_card_subtype:
choices:
- None
- flex-util
- flex-flash
- SDCARD
default: None
description:
- The subtype for the selected device type.
- Option is used when device_type is sd_card.
type: str
usb_subtype:
choices:
- None
- usb-cd
- usb-fdd
- usb-hdd
default: None
description:
- The subtype for the selected device type.
- Option is used when device_type is usb.
type: str
virtual_media_subtype:
choices:
- None
- cimc-mapped-dvd
- cimc-mapped-hdd
- kvm-mapped-dvd
- kvm-mapped-hdd
- kvm-mapped-fdd
default: None
description:
- The subtype for the selected device type.
- Option is used when device_type is virtual_media.
type: str
type: list
organization:
default: default
description:
- 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.
type: str
validate_certs:
default: true
description:
- Boolean control for verifying the api_uri TLS certificate
type: bool
api_private_key:
description:
- 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.
required: true
type: path
configured_boot_mode:
choices:
- Legacy
- Uefi
default: Legacy
description:
- Sets the BIOS boot mode.
- UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the Master Boot
Record (MBR) partitioning scheme.
type: str
uefi_enable_secure_boot:
default: false
description:
- 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.
type: bool
api_repsonse:
description: The API response output returned by the specified resource.
returned: always
sample:
api_response:
Name: COS-Boot
ObjectType: boot.Policy
Tags:
- Key: Site
Value: RCDN
type: dict