модуль cisco.intersight.intersight_vlan_policy_info — Сбор сведений о политиках VLAN и содержащихся в них VLAN в Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.intersight.

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_vlan_policy_info.

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Получение полной информации о политиках VLAN и связанных с ними VLAN из Cisco Intersight.
Поиск политик по организации и имени политики, а также фильтрация VLAN по шаблонам имён.
Возвращает структурированные данные, объединяющие метаданные политики с подробными конфигурациями VLAN.
Поддерживает фильтрацию по организации, имени политики и имени VLAN.
Если фильтры не заданы, будут возвращены все политики VLAN и содержащиеся в них VLAN.
Возвращает структурированные данные со сведениями о политике и связанных с ней VLAN.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор открытого API-ключа, связанного с закрытым ключом. Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.
api_private_key path / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM для аутентификации в API Intersight. Если используется строка, для её шифрования следует использовать Ansible Vault. Например: 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-----’ Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.
api_uri string	URI для доступа к API Intersight. Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI. По умолчанию: `"https://intersight.com/api/v1"`
name string	Точное имя политики VLAN, сведения о которой необходимо получить. Если указано, будут возвращены только соответствующая политика и содержащиеся в ней VLAN. Можно сочетать с фильтром vlan_name, чтобы получить конкретные VLAN из указанной политики.
organization string	Имя организации, по которому следует фильтровать политики VLAN. Для организации по умолчанию используйте ‘default’. Если указано, будут возвращены только политики этой организации.
use_proxy boolean	Если задано значение `no`, прокси-сервер использоваться не будет, даже если он указан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логическое значение, управляющее проверкой TLS-сертификата api_uri. Варианты: `false` `true` ← (по умолчанию)
vlan_name string	Фильтрация VLAN по имени в политиках. Можно использовать как с фильтром по имени политики, так и без него. Поддерживается точное совпадение (например, “prod_100” будет соответствовать только “prod_100”). В сочетании с именем политики фильтрует VLAN в этой конкретной политике.

Примеры

# Basic Usage Examples
- name: Fetch all VLAN Policies and their VLANs from all organizations
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_vlan_policies

# Organization-specific Examples
- name: Fetch all VLAN Policies from the default organization
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
  register: default_org_policies

- name: Fetch all VLAN Policies from a custom organization
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
  register: engineering_policies

# Specific Policy Examples
- name: Fetch a specific VLAN Policy by name with all its VLANs
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "datacenter-vlan-policy"
  register: specific_policy

- name: Display policy details
  debug:
    msg: "Policy {{ specific_policy.api_response.policy.Name }} has {{ specific_policy.api_response.vlans | length }} VLANs"

# VLAN Filtering Examples
- name: Find all policies containing a specific VLAN
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    vlan_name: "prod_100"
  register: policies_with_prod_100

- name: Find specific VLAN in a specific policy
  cisco.intersight.intersight_vlan_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "datacenter-vlan-policy"
    vlan_name: "mgmt_300"
  register: specific_vlan_in_policy

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
api_response dictionary	Ответ API, содержащий сведения о политике и VLAN. При запросе одной политики или если политики не найдены возвращает словарь. Если найдено несколько политик, возвращает список. Возвращается: всегда Пример: {"vlan_policy": {"Description": "VLAN policy for datacenter infrastructure", "Moid": "12345678901234567890abcd", "Name": "datacenter-vlan-policy", "ObjectType": "fabric.EthNetworkPolicy", "Organization": {"Name": "default", "ObjectType": "organization.Organization"}, "Tags": [{"Key": "Site", "Value": "DataCenter-A"}, {"Key": "Environment", "Value": "Production"}]}, "vlans": [{"AutoAllowOnUplinks": true, "IsNative": false, "Moid": "vlan12345678901234567890", "MulticastPolicy": {"Name": "default-multicast-policy", "ObjectType": "fabric.MulticastPolicy"}, "Name": "prod_100", "ObjectType": "fabric.Vlan", "SharingType": "None", "VlanId": 100}, {"AutoAllowOnUplinks": true, "IsNative": false, "Moid": "vlan09876543210987654321", "Name": "dmz_primary_50", "ObjectType": "fabric.Vlan", "PrimaryVlanId": 0, "SharingType": "Primary", "VlanId": 50}, {"AutoAllowOnUplinks": true, "IsNative": false, "Moid": "vlanabcdef1234567890123456", "Name": "dmz_isolated_51", "ObjectType": "fabric.Vlan", "PrimaryVlanId": 50, "SharingType": "Isolated", "VlanId": 51}]}
vlan_policy dictionary	Сведения о политике VLAN Возвращается: всегда
vlans list / elements=string	Список VLAN, связанных с политикой Возвращается: всегда

Авторы

Ron Gershburg (@rgershbu)

Ссылки на коллекцию

© 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_vlan_policy_info_module.html