intersight_boot_order_policy

Boot Order policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_boot_order_policy

Synopsis

Boot Order policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			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 if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	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. Choices: `present`, `absent`
organization	string		`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.
name	string	yes		The name assigned to the Boot Order policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			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(_).
tags	list			List of tags in Key: Value: format.
configured_boot_mode	string		`Legacy`	Sets the BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the Master Boot Record (MBR) partitioning scheme. Choices: `Legacy`, `Uefi`
uefi_enable_secure_boot	bool		`false`	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.
boot_devices	list			List of Boot Devices configured on the endpoint. Nested options: enabled (bool) default=true; device_type (str) required; device_name (str) required; network_slot (str); port (int); controller_slot (str); bootloader_name (str) default=; bootloader_description (str) default=; bootloader_path (str) default=; ip_type (str) default=None; interface_source (str) default=name; interface_name (str); mac_address (str); sd_card_subtype (str) default=None; lun (int); wwpn (str); usb_subtype (str) default=None; virtual_media_subtype (str) default=None

Example

yaml

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

- cisco.intersight.intersight_boot_order_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    boot_devices:
        - device_name: SAN-Primary
          device_type: SAN
          interface_name: fc0
          lun: 0
          network_slot: MLOM
          wwpn: 50:00:00:25:B5:00:00:01
    configured_boot_mode: Uefi
    description: Boot Order policy with SAN boot device
    name: SAN-Boot
    organization: DevNet
  name: Configure Boot Order Policy with SAN Boot

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