cisco.intersight.intersight_vnic_template_info module – Gather information about vNIC Templates 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_vnic_template_info.
Synopsis
Retrieve comprehensive information about vNIC Templates from Cisco Intersight.
Query templates by organization, template name, or other filters.
Returns structured data with template metadata and policy associations.
If no filters are provided, all vNIC Templates will be returned.
vNIC Templates are used to define standardized network interface configurations for FI-Attached deployments.
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 exact name of the vNIC Template to retrieve information from. When specified, only the matching template will be returned. |
|
The name of the organization to filter vNIC Templates by. Use ‘default’ for the default organization. When specified, only templates from this organization will be returned. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
# Basic Usage Examples
- name: Fetch all vNIC Templates from all organizations
cisco.intersight.intersight_vnic_template_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
register: all_vnic_templates
- name: Display all template names
debug:
msg: "Template: {{ item.Name }}"
loop: "{{ all_vnic_templates.api_response }}"
when: all_vnic_templates.api_response is iterable
# Organization-specific Examples
- name: Fetch all vNIC Templates from the default organization
cisco.intersight.intersight_vnic_template_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
register: default_org_templates
- name: Fetch all vNIC Templates from a custom organization
cisco.intersight.intersight_vnic_template_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Engineering"
register: engineering_templates
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response containing vNIC Template information. Returns a dictionary when querying a single template or no templates found. Returns a list when multiple templates are found. Returned: always Sample: |