cisco.intersight.intersight_ethernet_adapter_policy module – Ethernet Adapter 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_ethernet_adapter_policy.
Synopsis
Manages Ethernet Adapter Policy configuration on Cisco Intersight.
Configure virtual ethernet interface settings including advanced features like RDMA, QoS, and offload capabilities.
For more information see Cisco Intersight.
Parameters
Parameter |
Comments |
|---|---|
Enables advanced filtering on the interface. Choices:
|
|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
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. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
Status of Accelerated Receive Flow Steering on the virtual ethernet interface. Choices:
|
|
The number of completion queue resources to allocate. In general, the number of completion queue resources to allocate is equal to the number of transmit queue resources plus the number of receive queue resources. Default: |
|
The number of descriptors in each completion queue. Default: |
|
The user-defined description for the Ethernet Adapter Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
Enables EtherChannel Pinning to combine multiple physical links between two network switches into a single logical link. Transmit Queue Count should be at least 2 to enable ether channel pinning. Choices:
|
|
GENEVE offload protocol allows you to create logical networks that span physical network boundaries. Cannot be enabled simultaneously with ARFS. Choices:
|
|
The time to wait between interrupts or the idle period that must be encountered before an interrupt is sent. To turn off interrupt coalescing, enter 0 (zero) in this field. Default: |
|
Interrupt Coalescing Type. MIN - The system waits for the time specified in the Coalescing Time field before sending another interrupt event. IDLE - The system does not send an interrupt until there is a period of no activity lasting at least as long as the time specified in the Coalescing Time field. Choices:
|
|
The number of interrupt resources to allocate. Typical value is be equal to the number of completion queue resources. Default: |
|
Preferred driver interrupt mode. MSIx - Message Signaled Interrupts (MSI) with the optional extension (recommended). MSI - MSI only. INTx - PCI INTx interrupts. Choices:
|
|
Enables Interrupt Scaling on the interface. Choices:
|
|
The name assigned to the Ethernet Adapter Policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
Status of the Network Virtualization using Generic Routing Encapsulation on the virtual ethernet interface. Choices:
|
|
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: |
|
Status of Precision Time Protocol (PTP) on the virtual ethernet interface. PTP can be enabled only on one vNIC on an adapter. Choices:
|
|
The Class of Service for RoCE on this virtual interface. Only applicable when roce_enabled is true. Choices:
|
|
If enabled sets RDMA over Converged Ethernet (RoCE) on this virtual interface. Cannot be enabled simultaneously with NVGRE. Choices:
|
|
The number of memory regions per adapter. Recommended value = integer power of 2. Only applicable when roce_enabled is true. Default: |
|
The number of queue pairs per adapter. Recommended value = integer power of 2. Only applicable when roce_enabled is true. Default: |
|
The number of resource groups per adapter. Recommended value = be an integer power of 2 greater than or equal to the number of CPU cores. Only applicable when roce_enabled is true. Default: |
|
Configure RDMA over Converged Ethernet (RoCE) version on the virtual interface. Only RoCEv1 is supported on Cisco VIC 13xx series adapters and only RoCEv2 is supported on Cisco VIC 14xx series adapters. Only applicable when roce_enabled is true. Choices:
|
|
Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores. Choices:
|
|
When enabled, the IPv4 address is used for traffic distribution. Choices:
|
|
When enabled, the IPv6 extensions are used for traffic distribution. Choices:
|
|
When enabled, the IPv6 address is used for traffic distribution. Choices:
|
|
When enabled, both the IPv4 address and TCP port number are used for traffic distribution. Choices:
|
|
When enabled, both the IPv6 extensions and TCP port number are used for traffic distribution. Choices:
|
|
When enabled, both the IPv6 address and TCP port number are used for traffic distribution. Choices:
|
|
When enabled, both the IPv4 address and UDP port number are used for traffic distribution. Choices:
|
|
When enabled, both the IPv6 address and UDP port number are used for traffic distribution. Choices:
|
|
The number of receive queue resources to allocate. Default: |
|
The number of descriptors in each receive queue. Default: |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
Enables the reassembly of segmented packets in hardware before sending them to the CPU. Choices:
|
|
Enables the CPU to send large packets to the hardware for segmentation. Choices:
|
|
When enabled, the CPU sends all packet checksums to the hardware for validation. Choices:
|
|
When enabled, the CPU sends all packets to the hardware so that the checksum can be calculated. Choices:
|
|
The number of transmit queue resources to allocate. Default: |
|
The number of descriptors in each transmit queue. Default: |
|
Uplink Failback Timeout in seconds when uplink failover is enabled for a vNIC. After a vNIC has started using its secondary interface, this setting controls how long the primary interface must be available before the system resumes using the primary interface for the vNIC. Default: |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
|
Status of the Virtual Extensible LAN Protocol on the virtual ethernet interface. Choices:
|
Examples
- name: Create a basic Ethernet Adapter Policy
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "basic-ethernet-adapter-policy"
description: "Basic Ethernet adapter policy with default settings"
tags:
- Key: "Environment"
Value: "Production"
- name: Create an Ethernet Adapter Policy with VXLAN and advanced features
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "advanced-ethernet-adapter-policy"
description: "Advanced Ethernet adapter policy with VXLAN and PTP"
vxlan_enabled: true
ptp_enabled: true
advanced_filter: true
interrupt_scaling: true
interrupt_count: 16
rx_queue_count: 8
tx_queue_count: 4
completion_queue_count: 12
tags:
- Key: "Environment"
Value: "Production"
- Key: "Feature"
Value: "Advanced"
- name: Create an Ethernet Adapter Policy with RoCE enabled
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "roce-ethernet-adapter-policy"
description: "Ethernet adapter policy with RoCE v2 enabled"
roce_enabled: true
roce_queue_pairs: 256
roce_memory_regions: 131072
roce_resource_groups: 2
roce_version: 2
roce_class_of_service: 5
tags:
- Key: "Protocol"
Value: "RoCE"
- name: Create an Ethernet Adapter Policy with EtherChannel pinning
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "etherchannel-adapter-policy"
description: "Ethernet adapter policy with EtherChannel pinning"
etherchannel_pinning_enabled: true
tx_queue_count: 2
completion_queue_count: 6
tags:
- Key: "Feature"
Value: "EtherChannel"
- name: Create an Ethernet Adapter Policy with custom RSS settings
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "custom-rss-adapter-policy"
description: "Ethernet adapter policy with custom RSS configuration"
rss_enabled: true
rss_ipv4_hash: true
rss_ipv6_hash: false
rss_tcp_ipv4_hash: false
rss_tcp_ipv6_hash: false
rss_udp_ipv4_hash: true
rss_udp_ipv6_hash: true
tags:
- Key: "Feature"
Value: "CustomRSS"
- name: Delete an Ethernet Adapter Policy
cisco.intersight.intersight_ethernet_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "old-ethernet-adapter-policy"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response output returned by the specified resource. Returned: always Sample: |