cisco.intersight.intersight_firmware_policy module – Firmware Policy configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.3.0).

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_firmware_policy.

Synopsis

  • Manages Firmware Policy configuration on Cisco Intersight.

  • A policy to configure firmware settings and versions for Cisco Intersight managed servers.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

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.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

description

aliases: descr

string

The user-defined description for the Firmware Policy.

Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

exclude_drives

boolean

When set to true, excludes local disk drives from firmware upgrades.

This adds local-disk to the ExcludeComponentList.

Choices:

  • false ← (default)

  • true

exclude_storage_controllers

boolean

When set to true, excludes storage controllers from firmware upgrades.

This adds storage-controller to the ExcludeComponentList.

Choices:

  • false ← (default)

  • true

model_bundle_combo

list / elements=dictionary

List of server model and firmware version pairs.

Each entry specifies which firmware version should be used for a specific server model family.

This parameter is required when state is present.

bundle_version

string / required

The firmware bundle version to apply to the specified model family.

model_family

string / required

The server model family (e.g., UCSC-C220-M5, UCSC-C220-M4, UCSC-C220-M7).

name

string / required

The name assigned to the Firmware Policy.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

organization

string

The name of the Organization this resource is assigned to.

Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.

Default: "default"

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

Default: []

target_platform

string

The platform type for which the firmware policy is intended.

Server type can be either Standalone or FIAttached.

This parameter is required when state is present.

Choices:

  • "Standalone"

  • "FIAttached"

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

- name: Create a firmware policy for standalone servers
  cisco.intersight.intersight_firmware_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Standalone-Firmware-Policy"
    description: "Firmware policy for standalone servers"
    target_platform: "Standalone"
    model_bundle_combo:
      - model_family: "UCSC-C220-M5"
        bundle_version: "4.3(2.250037)"
      - model_family: "UCSC-C220-M4"
        bundle_version: "4.1(2m)"
    tags:
      - Key: "Environment"
        Value: "Production"

- name: Create a firmware policy with excluded components
  cisco.intersight.intersight_firmware_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Firmware-Policy-With-Exclusions"
    description: "Firmware policy excluding storage components"
    target_platform: "Standalone"
    model_bundle_combo:
      - model_family: "UCSC-C220-M7"
        bundle_version: "4.3(4.242038)"
    exclude_drives: true
    exclude_storage_controllers: true
    tags:
      - Key: "Site"
        Value: "Datacenter1"

- name: Delete a firmware policy
  cisco.intersight.intersight_firmware_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Old-Firmware-Policy"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"ExcludeComponentList": ["local-disk", "storage-controller"], "ModelBundleCombo": [{"BundleVersion": "4.3(2.250037)", "ModelFamily": "UCSC-C220-M5"}], "Name": "Standalone-Firmware-Policy", "ObjectType": "firmware.Policy", "Tags": [{"Key": "Environment", "Value": "Production"}], "TargetPlatform": "Standalone"}}

Authors

  • Ron Gershburg (@rgershbu)