Модуль cisco.intersight.intersight_vlan_policy — управление политиками 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.

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

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

Создание, обновление и удаление политик VLAN в Cisco Intersight.
Управление отдельными VLAN в рамках политик VLAN.
Поддержка обычных VLAN и конфигураций частных VLAN (Primary, Isolated, Community).
Политики VLAN определяют сегментацию сети и могут быть назначены политикам подключения LAN и профилям серверов.
Дополнительную информацию см. в документации Cisco Intersight.

Параметры

Параметр	Комментарии
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"`
description псевдонимы: descr string	Описание политики VLAN, заданное пользователем. Описание может содержать буквы (a–z, A–Z), цифры (0–9), дефис (-), точку (.), двоеточие (:) или подчёркивание (_).
name string / обязательный	Имя, присвоенное политике VLAN. Имя должно быть уникальным в пределах организации. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Политики, созданные в пользовательской организации, применимы только к устройствам в этой же организации. Для организации по умолчанию используйте ‘default’. По умолчанию: `"default"`
state string	Если задано значение `present`, проверяется наличие ресурса и при необходимости он создаётся. Если задано значение `absent`, проверяется отсутствие ресурса и при необходимости он удаляется. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / элементы=dictionary	Список тегов в формате Key:<ключ, заданный пользователем> Value:<значение, заданное пользователем>.
use_proxy boolean	Если задано значение `no`, прокси-сервер не будет использоваться, даже если он указан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, управляющий проверкой TLS-сертификата api_uri. Варианты: `false` `true` ← (по умолчанию)
vlans list / элементы=dictionary	Список VLAN для создания и назначения политике VLAN. Имя каждой VLAN будет задано по шаблону `prefix_vlan_id` (например, prod_100). Оставьте список пустым, чтобы создать политику без VLAN и настроить её вручную позже.
auto_allow_on_uplinks boolean	Нужно ли автоматически разрешать эту VLAN на восходящих каналах. Варианты: `false` `true` ← (по умолчанию)
enable_sharing boolean	Если параметр выбран, включаются параметры совместного использования частной VLAN. Варианты: `false` ← (по умолчанию) `true`
is_native boolean	Является ли эта VLAN собственной VLAN домена межкоммутаторного соединения Fabric Interconnect. Варианты: `false` ← (по умолчанию) `true`
multicast_policy_name string	Имя политики многоадресной рассылки, связываемой с этой VLAN. Обязательный параметр, если enable_sharing имеет значение false.
prefix string / обязательный	Префикс имени VLAN. Объединяется с vlan_id для создания полного имени VLAN (prefix_vlan_id).
primary_vlan_id integer	Идентификатор основной VLAN, если тип совместного использования VLAN — Isolated или Community.
sharing_type string	Тип совместного использования VLAN, если enable_sharing имеет значение true. Используйте значения в нижнем регистре (primary, isolated, community). Варианты: `"primary"` `"isolated"` `"community"`
state string	Создать или обновить VLAN либо удалить её. Варианты: `"present"` ← (по умолчанию) `"absent"`
vlan_id string / обязательный	Укажите допустимый идентификатор VLAN или диапазон идентификаторов от 2 до 4093. Можно указать диапазон идентификаторов через дефис (например, «30-40» создаст VLAN с 30 по 40). Примеры допустимых идентификаторов VLAN и диапазонов: 50, 200, «2000-2100». Нельзя использовать VLAN 4043–4047, 4094 и 4095, так как эти идентификаторы зарезервированы для системного использования. За один раз можно создать не более 3000 VLAN. Идентификатор VLAN — отдельный идентификатор 100 или диапазон «30-40» (диапазоны необходимо заключать в кавычки). Значение должно быть уникальным в пределах домена межкоммутаторного соединения Fabric Interconnect. При использовании диапазонов будет создано несколько VLAN с именами по шаблону prefix_vlanid. Для несмежных VLAN создавайте отдельные блоки VLAN вместо перечисления значений через запятую.

Примеры

- name: Create a VLAN Policy with multiple VLANs
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "datacenter-vlan-policy"
    description: "VLAN policy for datacenter infrastructure"
    tags:
      - Key: "Environment"
        Value: "Production"
      - Key: "Site"
        Value: "DataCenter-A"
    vlans:
      - prefix: "prod"
        vlan_id: 100
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
      - prefix: "dev"
        vlan_id: 200
        auto_allow_on_uplinks: false
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
      - prefix: "mgmt"
        vlan_id: 300
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
        is_native: true
    state: present

- name: Create a VLAN Policy with VLAN sharing (Private VLANs)
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "private-vlan-policy"
    description: "Policy with private VLAN configuration"
    vlans:
      - prefix: "primary"
        vlan_id: 79
        enable_sharing: true
        sharing_type: "primary"
        auto_allow_on_uplinks: true
      - prefix: "isolated"
        vlan_id: 90
        enable_sharing: true
        sharing_type: "isolated"
        primary_vlan_id: 79
        auto_allow_on_uplinks: true
      - prefix: "community"
        vlan_id: 91
        enable_sharing: true
        sharing_type: "community"
        primary_vlan_id: 79
        auto_allow_on_uplinks: true
    state: present

- name: Create a VLAN Policy with mixed configurations
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
    name: "mixed-vlan-policy"
    description: "Mixed configuration with shared and non-shared VLANs"
    vlans:
      - prefix: "web"
        vlan_id: 10
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "web-multicast-policy"
      - prefix: "db"
        vlan_id: 20
        auto_allow_on_uplinks: false
        enable_sharing: false
        state: absent
        multicast_policy_name: "db-multicast-policy"
      - prefix: "dmz_primary"
        vlan_id: 50
        enable_sharing: true
        sharing_type: "primary"
        auto_allow_on_uplinks: true
        state: present
      - prefix: "dmz_isolated"
        vlan_id: 51
        enable_sharing: true
        sharing_type: "isolated"
        primary_vlan_id: 50
        auto_allow_on_uplinks: true
    state: present

- name: Create a VLAN Policy with VLAN ranges
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "range-vlan-policy"
    description: "Policy with VLAN ranges"
    vlans:
      - prefix: "prod"
        vlan_id: "30-40"
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
      - prefix: "dev"
        vlan_id: "100-110"
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
      - prefix: "mgmt"
        vlan_id: 200
        auto_allow_on_uplinks: true
        enable_sharing: false
        multicast_policy_name: "default-multicast-policy"
    state: present

- name: Create a VLAN Policy with minimal configuration (policy only)
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "empty-vlan-policy"
    description: "Empty policy for manual VLAN configuration"
    state: present

- name: Update an existing VLAN Policy
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "datacenter-vlan-policy"
    description: "Updated description for datacenter infrastructure"
    tags:
      - Key: "Environment"
        Value: "Production"
      - Key: "Site"
        Value: "DataCenter-A"
      - Key: "Updated"
        Value: "2024-01-01"
    state: present

- name: Delete a VLAN Policy
  cisco.intersight.intersight_vlan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "datacenter-vlan-policy"
    state: absent

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

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

Ключ	Описание
api_response dictionary	Выходные данные ответа API, возвращённые указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"Name": "test_vlan_policy", "ObjectType": "fabric.EthNetworkPolicy", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}`

Авторы

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_module.html