intersight_firmware_policy

Firmware Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_firmware_policy

Synopsis

Firmware 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, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Firmware Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list		`[]`	List of tags in Key: Value: format.
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 C(state) is C(present). Choices: `Standalone`, `FIAttached`
exclude_drives	bool		`false`	When set to C(true), excludes local disk drives from firmware upgrades. This adds local-disk to the ExcludeComponentList.
exclude_storage_controllers	bool		`false`	When set to C(true), excludes storage controllers from firmware upgrades. This adds storage-controller to the ExcludeComponentList.
model_bundle_combo	list			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 C(state) is C(present). Nested options: model_family (str) required; bundle_version (str) required

Example

yaml

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

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

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