cisco.intersight.intersight_ethernet_adapter_policy_info module – Gather information about Ethernet Adapter Policies in 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_info.
Synopsis
Gather information about Ethernet Adapter Policies in Cisco Intersight.
Information can be filtered by
organizationandname.If no filters are passed, all Ethernet Adapter Policies will be returned.
Returns comprehensive policy configuration including VXLAN, NVGRE, ARFS, PTP, RoCE, queue settings, and offload configurations.
Parameters
Parameter |
Comments |
|---|---|
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: |
|
The name of the Ethernet Adapter Policy to gather information from. |
|
The name of the organization the Ethernet Adapter Policy belongs to. Use ‘default’ for the default organization. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- name: Fetch all Ethernet Adapter Policies
cisco.intersight.intersight_ethernet_adapter_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
register: all_adapter_policies
- name: Fetch Ethernet Adapter Policies from a specific organization
cisco.intersight.intersight_ethernet_adapter_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Engineering"
register: engineering_adapter_policies
- name: Fetch a specific Ethernet Adapter Policy by name
cisco.intersight.intersight_ethernet_adapter_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "high-performance-adapter-policy"
register: specific_adapter_policy
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: |