cisco.intersight.intersight_adapter_config_policy module – Adapter Configuration Policy for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.18.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_adapter_config_policy.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages Adapter Configuration Policy on Cisco Intersight.
This policy allows you to configure adapter settings such as LLDP, FIP, Port Channel, and FEC mode.
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 Adapter Configuration Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
name string / required	The name assigned to the Adapter Configuration 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"`
settings list / elements=dictionary	List of adapter configurations.
dce_interface_1_fec_mode string	Forward Error Correction (FEC) mode setting for DCE interface 1 (Interface ID 0). Supported only for Cisco VIC 14xx adapters. FEC mode ‘cl74’ is unsupported for Cisco VIC 1495/1497. Choices: `"cl91"` ← (default) `"cl74"` `"off"`
dce_interface_2_fec_mode string	Forward Error Correction (FEC) mode setting for DCE interface 2 (Interface ID 1). Choices: `"cl91"` ← (default) `"cl74"` `"off"`
dce_interface_3_fec_mode string	Forward Error Correction (FEC) mode setting for DCE interface 3 (Interface ID 2). Choices: `"cl91"` ← (default) `"cl74"` `"off"`
dce_interface_4_fec_mode string	Forward Error Correction (FEC) mode setting for DCE interface 4 (Interface ID 3). Choices: `"cl91"` ← (default) `"cl74"` `"off"`
enable_fip boolean	Status of FIP protocol on the adapter interfaces. Choices: `false` `true` ← (default)
enable_lldp boolean	Status of LLDP protocol on the adapter interfaces. Choices: `false` `true` ← (default)
enable_port_channel boolean	Status of Port Channel on the adapter interfaces. When enabled, two vNICs and two vHBAs are available. When disabled, four vNICs and four vHBAs are available. Disabling port channel reboots the server. Supported only for Cisco VIC 1455/1457 adapters. Choices: `false` `true` ← (default)
slot_id string / required	PCIe slot where the VIC adapter is installed. Supported values are (1-15) and MLOM.
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: `[]`
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 Adapter Config Policy
  cisco.intersight.intersight_adapter_config_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "adapter-config-policy"
    description: "Policy for VIC 1455"
    settings:
      - slot_id: "2"
        enable_lldp: true
        enable_fip: true
        enable_port_channel: true
        dce_interface_1_fec_mode: "cl91"
        dce_interface_2_fec_mode: "cl91"
        dce_interface_3_fec_mode: "cl91"
        dce_interface_4_fec_mode: "off"
    state: present

- name: Delete Adapter Config Policy
  cisco.intersight.intersight_adapter_config_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "adapter-config-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: `{"Name": "adapter-config-policy", "ObjectType": "adapter.ConfigPolicy", "Settings": [{"DceInterfaceSettings": [{"FecMode": "cl91", "InterfaceId": 0}], "EthSettings": {"LldpEnabled": true}, "FcSettings": {"FipEnabled": true}, "PortChannelSettings": {"Enabled": true}, "SlotId": "2"}]}`

Authors

Ron Gershburg (@rgershbu)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_adapter_config_policy_module.html