intersight_ethernet_adapter_policy

Ethernet Adapter Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_ethernet_adapter_policy

Synopsis

Ethernet Adapter 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 Ethernet Adapter Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			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(_).
tags	list			List of tags in Key: Value: format.
vxlan_enabled	bool		`false`	Status of the Virtual Extensible LAN Protocol on the virtual ethernet interface.
nvgre_enabled	bool		`false`	Status of the Network Virtualization using Generic Routing Encapsulation on the virtual ethernet interface.
arfs_enabled	bool		`false`	Status of Accelerated Receive Flow Steering on the virtual ethernet interface.
ptp_enabled	bool		`false`	Status of Precision Time Protocol (PTP) on the virtual ethernet interface. PTP can be enabled only on one vNIC on an adapter.
advanced_filter	bool		`false`	Enables advanced filtering on the interface.
interrupt_scaling	bool		`false`	Enables Interrupt Scaling on the interface.
geneve_enabled	bool		`false`	GENEVE offload protocol allows you to create logical networks that span physical network boundaries. Cannot be enabled simultaneously with ARFS.
etherchannel_pinning_enabled	bool		`false`	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.
roce_enabled	bool		`false`	If enabled sets RDMA over Converged Ethernet (RoCE) on this virtual interface. Cannot be enabled simultaneously with NVGRE.
roce_queue_pairs	int		`256`	The number of queue pairs per adapter. Recommended value = integer power of 2. Only applicable when roce_enabled is true.
roce_memory_regions	int		`131072`	The number of memory regions per adapter. Recommended value = integer power of 2. Only applicable when roce_enabled is true.
roce_resource_groups	int		`2`	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.
roce_version	int		`1`	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: `1`, `2`
roce_class_of_service	int		`5`	The Class of Service for RoCE on this virtual interface. Only applicable when roce_enabled is true. Choices: `1`, `2`, `4`, `5`, `6`
interrupt_count	int		`8`	The number of interrupt resources to allocate. Typical value is be equal to the number of completion queue resources.
interrupt_mode	string		`MSIx`	Preferred driver interrupt mode. MSIx - Message Signaled Interrupts (MSI) with the optional extension (recommended). MSI - MSI only. INTx - PCI INTx interrupts. Choices: `MSIx`, `MSI`, `INTx`
interrupt_coalescing_time	int		`125`	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.
interrupt_coalescing_type	string		`MIN`	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: `MIN`, `IDLE`
rx_queue_count	int		`4`	The number of receive queue resources to allocate.
rx_ring_size	int		`512`	The number of descriptors in each receive queue.
tx_queue_count	int		`1`	The number of transmit queue resources to allocate.
tx_ring_size	int		`256`	The number of descriptors in each transmit queue.
completion_queue_count	int		`5`	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.
completion_ring_size	int		`1`	The number of descriptors in each completion queue.
uplink_failback_timeout	int		`5`	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.
tcp_tx_checksum	bool		`true`	When enabled, the CPU sends all packets to the hardware so that the checksum can be calculated.
tcp_rx_checksum	bool		`true`	When enabled, the CPU sends all packet checksums to the hardware for validation.
tcp_large_send	bool		`true`	Enables the CPU to send large packets to the hardware for segmentation.
tcp_large_receive	bool		`true`	Enables the reassembly of segmented packets in hardware before sending them to the CPU.
rss_enabled	bool		`true`	Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores.
rss_ipv4_hash	bool		`true`	When enabled, the IPv4 address is used for traffic distribution.
rss_ipv6_hash	bool		`false`	When enabled, the IPv6 address is used for traffic distribution.
rss_ipv6_ext_hash	bool		`true`	When enabled, the IPv6 extensions are used for traffic distribution.
rss_tcp_ipv4_hash	bool		`true`	When enabled, both the IPv4 address and TCP port number are used for traffic distribution.
rss_tcp_ipv6_hash	bool		`false`	When enabled, both the IPv6 address and TCP port number are used for traffic distribution.
rss_tcp_ipv6_ext_hash	bool		`true`	When enabled, both the IPv6 extensions and TCP port number are used for traffic distribution.
rss_udp_ipv4_hash	bool		`false`	When enabled, both the IPv4 address and UDP port number are used for traffic distribution.
rss_udp_ipv6_hash	bool		`false`	When enabled, both the IPv6 address and UDP port number are used for traffic distribution.

Example

yaml

- cisco.intersight.intersight_ethernet_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Basic Ethernet adapter policy with default settings
    name: basic-ethernet-adapter-policy
    tags:
        - Key: Environment
          Value: Production
  name: Create a basic Ethernet Adapter Policy

- cisco.intersight.intersight_ethernet_adapter_policy:
    advanced_filter: true
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    completion_queue_count: 12
    description: Advanced Ethernet adapter policy with VXLAN and PTP
    interrupt_count: 16
    interrupt_scaling: true
    name: advanced-ethernet-adapter-policy
    ptp_enabled: true
    rx_queue_count: 8
    tags:
        - Key: Environment
          Value: Production
        - Key: Feature
          Value: Advanced
    tx_queue_count: 4
    vxlan_enabled: true
  name: Create an Ethernet Adapter Policy with VXLAN and advanced features

- cisco.intersight.intersight_ethernet_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Ethernet adapter policy with RoCE v2 enabled
    name: roce-ethernet-adapter-policy
    roce_class_of_service: 5
    roce_enabled: true
    roce_memory_regions: 131072
    roce_queue_pairs: 256
    roce_resource_groups: 2
    roce_version: 2
    tags:
        - Key: Protocol
          Value: RoCE
  name: Create an Ethernet Adapter Policy with RoCE enabled

- cisco.intersight.intersight_ethernet_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    completion_queue_count: 6
    description: Ethernet adapter policy with EtherChannel pinning
    etherchannel_pinning_enabled: true
    name: etherchannel-adapter-policy
    tags:
        - Key: Feature
          Value: EtherChannel
    tx_queue_count: 2
  name: Create an Ethernet Adapter Policy with EtherChannel pinning

- cisco.intersight.intersight_ethernet_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Ethernet adapter policy with custom RSS configuration
    name: custom-rss-adapter-policy
    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: Create an Ethernet Adapter Policy with custom RSS settings

- cisco.intersight.intersight_ethernet_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: old-ethernet-adapter-policy
    state: absent
  name: Delete an Ethernet Adapter Policy