модуль cisco.mso.ndo_set_rule_policy — управление политиками Set Rule для арендаторов в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля потребуются дополнительные компоненты. Подробные сведения см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_set_rule_policy.

Добавлено в cisco.mso 2.12.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

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

Управление политиками Set Rule для арендаторов в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND версии 4.1 (NDO версии 5.1) и более поздних.

Требования

На хосте, выполняющем этот модуль, должны быть соблюдены следующие требования.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
description string	Описание политики Set Rule.
host псевдонимы: hostname string	IP-адрес или имя хоста узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
login_domain string	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря `ansible_httpapi_login_domain`.
name псевдонимы: set_rule_policy string	Имя политики Set Rule.
output_level string	Определяет состав выходных данных этого модуля MSO. `normal` — стандартные выходные данные, включая словарь `current` `info` добавляет информационные выходные данные, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочные выходные данные, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
set_additional_community псевдонимы: set_add_communities list / элементы=string	Список сообществ, добавляемых в конец политики Set Rule. Передача пустого списка удалит `set_additional_community=[]` из политики Set Rule.
set_as_path dictionary	Правила пути автономной системы (AS), добавляемые в политику Set Rule. Передача пустого словаря удалит правила `set_as_path={}` из политики Set Rule.
last_asn_count integer	Количество последних AS для добавления в начало пути. Значение должно находиться в диапазоне от 1 до 10.
path_asn_list list / элементы=dictionary	Список номеров AS пути, добавляемых в начало. Передача пустого списка удалит `set_as_path.path_asn_list=[]`.
asn integer / обязательный	Номер AS. Значение должно находиться в диапазоне от 1 до 10.
order integer / обязательный	Порядок номера AS. Значение должно находиться в диапазоне от 0 до 31.
set_community dictionary	Правило сообщества, добавляемое в политику Set Rule. Передача пустого словаря удалит правило `set_community={}` из политики Set Rule.
community string	Значение сообщества.
criteria string	Критерий, применяемый к значению сообщества. Варианты: `"none"` `"replace"` `"append"`
set_dampening dictionary	Правило подавления колебаний маршрутов, добавляемое в политику Set Rule. Передача пустого словаря удалит правило `set_dampening={}` из политики Set Rule.
half_life integer	Время полураспада в минутах. Значение должно находиться в диапазоне от 1 до 60.
max_suppress_time integer	Максимальное время подавления в минутах. Значение должно находиться в диапазоне от 1 до 255.
reuse_limit integer	Порог повторного использования. Значение должно находиться в диапазоне от 1 до 20000.
suppress_limit integer	Порог подавления. Значение должно находиться в диапазоне от 1 до 20000.
set_metric string	Правило метрики, добавляемое в политику Set Rule. Значение должно находиться в диапазоне от 0 до 999999999. Передача пустой строки удалит правило `set_metric=""` из политики Set Rule.
set_metric_type string	Тип правила метрики, добавляемого в политику Set Rule. Передача пустой строки удалит `set_metric_type=""` из политики Set Rule. Варианты: `"ospf_type1"` `"ospf_type2"` `"type1"` `"type2"` `""`
set_multi_path boolean	Параметр многопутевой маршрутизации, добавляемый в политику Set Rule. Передача значения `false` удалит многопутевую маршрутизацию из политики Set Rule. Для включения многопутевой маршрутизации требуется включить `set_next_hop_propagate=true`. Варианты: `false` `true`
set_next_hop string	Правило следующего перехода, добавляемое в политику Set Rule. Значение должно быть допустимым IPv4- или IPv6-адресом. Передача пустой строки удалит правило `set_next_hop=""` из политики Set Rule.
set_next_hop_propagate boolean	Параметр распространения следующего перехода, добавляемый в политику Set Rule. Передача значения `false` удалит распространение следующего перехода из политики Set Rule. Невозможно включить `set_next_hop_propagate`, если настроен параметр `set_route_tag`. Варианты: `false` `true`
set_preference string	Правило предпочтения, добавляемое в политику Set Rule. Значение должно находиться в диапазоне от 0 до 999999999. Передача пустой строки удалит правило `set_preference=""` из политики Set Rule.
set_route_tag string	Правило тега маршрута, добавляемое в политику Set Rule. Значение должно быть числом в диапазоне от 0 до 999999999. Передача пустой строки удалит правило `set_route_tag=""` из политики Set Rule.
set_weight string	Правило веса, добавляемое в политику Set Rule. Значение должно быть числом в диапазоне от 0 до 9999. Передача пустой строки удалит правило `set_weight=""` из политики Set Rule.
state string	Определяет требуемое состояние ресурса. Используйте `absent`, чтобы удалить ресурс. Используйте `query`, чтобы получить список ресурсов. Используйте `present`, чтобы создать или обновить ресурс. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template string	Имя шаблона. Шаблон должен быть шаблоном арендатора. Необходимо указать этот параметр или `template_id`.
template_id string	Идентификатор шаблона арендатора. Необходимо указать этот параметр или `template`.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
use_proxy boolean	Если указано `false`, прокси-сервер использоваться не будет, даже если он задан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если указано `false`, вместо соединения HTTPS по умолчанию будет использоваться соединение HTTP. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря `ansible_httpapi_use_ssl`. Значение по умолчанию — `false` при использовании подключаемого модуля соединения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода соединения (только для mso). Варианты: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
uuid псевдонимы: set_rule_policy_uuid string	UUID политики Set Rule. Этот параметр обязателен, если требуется обновить атрибут `name`.
validate_certs boolean	Если указано `false`, SSL-сертификаты проверяться не будут. Значение `false` следует задавать только для контролируемых вами узлов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать template. Для создания шаблона арендатора используйте cisco.mso.ndo_template.
Этот модуль разработан для поддержки Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- name: Create a new Set Rule Policy
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: set_rule_policy_1
    description: Ansible Set Rule Policy
    set_community:
      community: no-export
      criteria: replace
    set_additional_community:
      - no-advertise
      - extended:color:35
    set_route_tag: 500
    set_dampening:
      half_life: 15
      reuse_limit: 750
      suppress_limit: 2000
      max_suppress_time: 60
    set_weight: 50
    set_next_hop: 'aa::'
    set_preference: 200
    set_metric: 100
    set_metric_type: type2
    set_as_path:
      last_asn_count: 10
      path_asn_list:
        - order: 11
          asn: 1
        - order: 10
          asn: 2
    state: present
  register: create_set_rule_policy_1

- name: Update the name of the Set Rule Policy using UUID
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ create_tenant.current.templateId }}"
    uuid: "{{ create_set_rule_policy_1.current.uuid }}"
    name: set_rule_policy_1_updated
    state: present
  register: update_set_rule_policy_1

- name: Query an existing Set Rule Policy using UUID
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ create_set_rule_policy_1.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query an existing Set Rule Policy using name
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: set_rule_policy_1_updated
    state: query
  register: query_with_name

- name: Query all Set Rule Policies
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    state: query
  register: query_all

- name: Remove set rules from a Set Rule Policy
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: set_rule_policy_1_updated
    set_additional_community: []
    set_community: {}
    set_route_tag: ''
    set_propagate_next_hop: false
    state: present

- name: Delete an existing Set Rule Policy using UUID
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ create_set_rule_policy_1.current.uuid }}"
    state: absent

- name: Delete an existing Set Rule Policy using Name
  cisco.mso.ndo_set_rule_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: set_rule_policy_1_updated
    state: absent

Авторы

Samita Bhattacharjee (@samiib)

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

© 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/mso/ndo_set_rule_policy_module.html