intersight_power_policy

Power Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_power_policy

Synopsis

Power 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 Power Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Power 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 power policy is intended. This determines which settings are applicable. This parameter is required when C(state) is C(present). Choices: `All`, `Standalone`, `FIAttached`, `Chassis`
power_profiling	string		`Enabled`	Sets the Power Profiling of the Server. If Enabled, this field allows the power manager to run power profiling utility to determine the power needs of the server. This field is only supported for Cisco UCS X series servers. Applicable for ‘FIAttached’ and ‘All’ platforms. Choices: `Enabled`, `Disabled`
power_priority	string		`Low`	Sets the Power Priority of the Server. This priority is used to determine the initial power allocation for servers. This field is only supported for Cisco UCS B series and X series servers. Applicable for ‘FIAttached’ and ‘All’ platforms. Choices: `Low`, `Medium`, `High`
power_restore	string		`AlwaysOff`	Sets the Power Restore State of the Server. In the absence of Intersight connectivity, the chassis/server will use this policy to recover the host power after a power loss event. Applicable for ‘Standalone’, ‘FIAttached’, and ‘All’ platforms. Choices: `AlwaysOff`, `AlwaysOn`, `LastState`
power_redundancy	string		`Grid`	Sets the Power Redundancy Mode of the Chassis. Redundancy Mode determines the number of PSUs the chassis keeps as redundant. N+2 mode is only supported for Cisco UCS X series Chassis. Applicable for ‘Chassis’ and ‘All’ platforms. Choices: `Grid`, `NotRedundant`, `N+1`, `N+2`
processor_package_power_limit	string		`Default`	Sets the Processor Package Power Limit (PPL) of a server. PPL refers to the amount of power that a CPU can draw from the power supply. The Processor Package Power Limit (PPL) feature is currently available exclusively on Cisco UCS C225/C245 M8 servers. Applicable for ‘Standalone’, ‘FIAttached’, and ‘All’ platforms. Choices: `Default`, `Maximum`, `Minimum`
power_save_mode	string		`Enabled`	Sets the power save mode of the chassis. If the requested power budget is less than available power capacity, the additional PSUs not required to comply with redundancy policy are placed in power save mode. Applicable for ‘Chassis’ and ‘All’ platforms. Choices: `Enabled`, `Disabled`
dynamic_power_rebalancing	string		`Enabled`	Sets the dynamic power rebalancing mode of the chassis. If enabled, this mode allows the chassis to dynamically reallocate the power between servers depending on their power usage. Applicable for ‘Chassis’ and ‘All’ platforms. Choices: `Enabled`, `Disabled`
extended_power_capacity	string		`Enabled`	Sets the Extended Power Capacity of the Chassis. If Enabled, this mode allows chassis available power to be increased by borrowing power from redundant power supplies. This option is only supported for Cisco UCS X series Chassis. Applicable for ‘Chassis’ and ‘All’ platforms. Choices: `Enabled`, `Disabled`
power_allocation	int		`0`	Sets the limit for the maximum input power consumption by the chassis (in Watts). Set to 0 for no limit. Applicable for ‘Chassis’ and ‘All’ platforms.

Example

yaml

- cisco.intersight.intersight_power_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Power policy for standalone servers, restores to last state.
    name: Standalone-Server-Power-Policy
    power_restore: LastState
    processor_package_power_limit: Minimum
    tags:
        - Key: Owner
          Value: DevOps
    target_platform: Standalone
  name: Create a Power Policy for a Standalone Server

- cisco.intersight.intersight_power_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Power policy for chassis with N+1 redundancy.
    name: Chassis-N1-Redundancy
    power_allocation: 7500
    power_redundancy: N+1
    power_save_mode: Disabled
    target_platform: Chassis
  name: Create a Power Policy for a Chassis with N+1 Redundancy

- cisco.intersight.intersight_power_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Default power policy for all FIAttached servers.
    name: FI-Attached-Default
    power_priority: Medium
    power_profiling: Enabled
    target_platform: FIAttached
  name: Create a universal Power Policy for FIAttached Servers

- cisco.intersight.intersight_power_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: Standalone-Server-Power-Policy
    state: absent
  name: Delete a Power Policy