Spec-Zone.ru › Ansible

Модуль cisco.intersight.intersight_switch_control_policy — настройка политики управления коммутаторами для Cisco Intersight

Примечание

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

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

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

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

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения

Обзор

  • Управляет настройкой политики управления коммутаторами в Cisco Intersight.
  • Политика для настройки режимов коммутации, оптимизации VLAN, времени устаревания MAC-адресов и параметров UDLD для межсоединений фабрики под управлением Cisco Intersight.
  • Дополнительные сведения см. в документации 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

Описание политики управления коммутаторами, заданное пользователем.

Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или подчёркивание (_).

ethernet_switching_mode

string

Включение или отключение режима коммутации Ethernet End Host.

Режим коммутации Ethernet End Host не применяется к Unified Edge; по умолчанию используется режим Ethernet Switch.

end-host — режим коммутации Ethernet End Host (по умолчанию).

switch — режим Ethernet Switch.

Варианты:

  • "end-host" ← (по умолчанию)
  • "switch"

fabric_pc_vhba_reset

string

Если параметр включён, адаптеру VIC отправляется уведомление об изменении зарегистрированного состояния (RSCN).

Это происходит при отключении любого порта-участника в порт-канале фабрики; для немедленного восстановления соединения выполняется сброс vHBA.

Если параметр отключён (по умолчанию), сброс vHBA выполняется только при отключении всех портов-участников порт-канала фабрики.

Сброс vHBA порт-канала фабрики не поддерживается в Unified Edge и не может быть включён.

enabled — включить сброс vHBA порт-канала фабрики.

disabled — отключить сброс vHBA порт-канала фабрики (по умолчанию).

Варианты:

  • "enabled"
  • "disabled" ← (по умолчанию)

fc_switching_mode

string

Включение или отключение режима коммутации FC End Host.

FC не поддерживается в Unified Edge, поэтому этот параметр нельзя настроить, и он игнорируется.

end-host — режим коммутации FC End Host (по умолчанию).

switch — режим FC Switch.

Варианты:

  • "end-host" ← (по умолчанию)
  • "switch"

mac_aging_option

string

Параметр настройки времени устаревания MAC-адресов.

default — использовать время устаревания MAC-адресов по умолчанию и интервал сообщений UDLD (по умолчанию).

custom — использовать пользовательское время устаревания MAC-адресов в секундах.

never — MAC-адреса не устаревают.

Варианты:

  • "default" ← (по умолчанию)
  • "custom"
  • "never"

mac_aging_time

integer

Задаёт время устаревания MAC-адресов в секундах.

Это поле действительно, если для mac_aging_option задано значение custom.

Допустимый диапазон: 120–918000 секунд.

По умолчанию: 14500

message_interval

integer

Настраивает интервал между пробными сообщениями UDLD на портах, где включён UDLD.

Допустимые значения — от 7 до 90 секунд.

По умолчанию: 15

name

string / обязательно

Имя, присвоенное политике управления коммутаторами.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

string

Имя организации, которой назначен этот ресурс.

Профили и политики, созданные в пользовательской организации, применимы только к устройствам в этой же организации.

По умолчанию: "default"

primary_key

string

Шифрует ключи MACsec в формате type-6.

Если ключ MACsec уже представлен в формате type-6, основной ключ расшифровывает его.

MACsec не поддерживается в Unified Edge, поэтому основной ключ нельзя настроить.

При задании длина должна составлять от 16 до 64 символов.

recovery_action

string

При включении действие восстановления UDLD пытается вывести порт, отключённый из-за ошибки UDLD, из состояния сброса.

none — без действия восстановления (по умолчанию).

reset — сбросить порт для восстановления после состояния отключения из-за ошибки UDLD.

Варианты:

  • "none" ← (по умолчанию)
  • "reset"

reserved_vlan_start_id

integer

Начальный идентификатор VLAN, зарезервированных для внутреннего использования в межсоединении фабрики.

Этот идентификатор VLAN является начальным идентификатором непрерывного диапазона из 128 VLAN, которые нельзя настроить для пользовательских данных.

Этот диапазон VLAN нельзя настроить в политике VLAN.

Если это свойство не настроено, по умолчанию для внутреннего использования резервируется диапазон VLAN 3915–4042.

В Unified Edge зарезервированный диапазон VLAN фиксирован, поэтому этот параметр нельзя настроить, и он игнорируется.

По умолчанию: 3915

state

string

Если указано present, проверяется наличие ресурса, и при необходимости он создаётся.

Если указано absent, проверяется отсутствие ресурса, и при необходимости он удаляется.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / элементы=dictionary

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

use_proxy

boolean

Если значение no, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Логический параметр, управляющий проверкой TLS-сертификата api_uri

Варианты:

  • false
  • true ← (по умолчанию)

vlan_port_optimization_enabled

boolean

Включает или отключает оптимизацию количества портов VLAN.

Эта функция всегда включена для Cisco UCS Fabric Interconnect 9108 100G.

Также включена начиная с версии пакета IMM 6.x.

Оптимизация количества портов VLAN не применяется к Unified Edge.

Варианты:

  • false ← (по умолчанию)
  • true

Примеры

- name: Create a Switch Control Policy with default settings
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "SwitchControl-Policy-01"
    description: "Switch control policy with default settings"
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    state: present

- name: Create a Switch Control Policy with custom settings
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SwitchControl-Custom-Policy"
    description: "Switch control policy with custom MAC aging"
    ethernet_switching_mode: switch
    fc_switching_mode: switch
    vlan_port_optimization_enabled: true
    reserved_vlan_start_id: 3915
    mac_aging_option: custom
    mac_aging_time: 14500
    message_interval: 15
    recovery_action: reset
    fabric_pc_vhba_reset: enabled
    primary_key: "mySecureKey12345"
    state: present

- name: Create a Switch Control Policy with end-host mode
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SwitchControl-EndHost-Policy"
    ethernet_switching_mode: end-host
    fc_switching_mode: end-host
    vlan_port_optimization_enabled: false
    recovery_action: none
    fabric_pc_vhba_reset: disabled
    state: present

- name: Create a Switch Control Policy with never aging MAC addresses
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SwitchControl-NeverAge-Policy"
    mac_aging_option: never
    message_interval: 20
    state: present

- name: Update a Switch Control Policy
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SwitchControl-Policy-01"
    description: "Updated switch control policy"
    ethernet_switching_mode: switch
    vlan_port_optimization_enabled: true
    state: present

- name: Delete a Switch Control Policy
  cisco.intersight.intersight_switch_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SwitchControl-Policy-01"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Результат ответа API, возвращённый указанным ресурсом.

Возвращается: всегда

Пример: {"api_response": {"EthernetSwitchingMode": "end-host", "FabricPcVhbaReset": "Disabled", "FcSwitchingMode": "end-host", "MacAgingSettings": {"MacAgingOption": "Default"}, "Name": "SwitchControl-Policy-01", "ObjectType": "fabric.SwitchControlPolicy", "ReservedVlanStartId": 3915, "Tags": [{"Key": "Site", "Value": "DataCenter-A"}], "UdldSettings": {"MessageInterval": 15, "RecoveryAction": "none"}, "VlanPortOptimizationEnabled": false}}

Авторы

  • 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_switch_control_policy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API