intersight_ipmi_over_lan_policy

IPMI over LAN Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_ipmi_over_lan_policy

Synopsis

IPMI over LAN 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 IPMI over LAN Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the IPMI over LAN 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.
enabled	bool		`true`	State of the IPMI Over LAN service on the endpoint. Enable or disable IPMI over LAN functionality on the server.
privilege	string		`admin`	The highest privilege level that can be assigned to an IPMI session on a server. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. Privilege level ‘user’ is not supported for B/X-Series servers. Choices: `admin`, `user`, `read-only`
encryption_key	string			The encryption key to use for IPMI communication. It should have an even number of hexadecimal characters and not exceed 40 characters. Use “00” to disable encryption key use. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. IPMI commands using this key should append zeroes to the key to achieve a length of 40 characters. Secret value; omitted from logs and results.

Example

yaml

- cisco.intersight.intersight_ipmi_over_lan_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: IPMI over LAN policy with encryption
    enabled: true
    encryption_key: AB2134AC
    name: IPMI-Policy-Encrypted
    organization: default
    privilege: admin
    state: present
    tags:
        - Key: Site
          Value: DataCenter-A
  name: Create IPMI over LAN Policy with encryption enabled

- cisco.intersight.intersight_ipmi_over_lan_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: IPMI over LAN policy without encryption
    enabled: true
    encryption_key: "00"
    name: IPMI-Policy-No-Encryption
    organization: default
    privilege: operator
    state: present
  name: Create IPMI over LAN Policy with encryption disabled

- cisco.intersight.intersight_ipmi_over_lan_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Disabled IPMI over LAN policy
    enabled: false
    name: IPMI-Policy-Disabled
    state: present
  name: Create disabled IPMI over LAN Policy

- cisco.intersight.intersight_ipmi_over_lan_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: IPMI-Policy-Encrypted
    state: absent
  name: Delete IPMI over LAN Policy