Модуль cisco.mso.mso_schema_template_anp_epg_contract — управление контрактами EPG в шаблонах схем

Примечание

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

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

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

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

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

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

Управление контрактами EPG в шаблонах схем Cisco ACI Multi-Site.

Требования

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

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

Параметры

Параметр	Комментарии
anp string / обязательный	Имя ANP.
contract dictionary	Контракт, связанный с этой EPG. Этот параметр нельзя использовать вместе с параметром contracts.
name string / обязательный	Имя контракта.
schema string	Имя схемы, в которой определён указанный контракт. Если параметр не указан, используется текущая схема.
template string	Имя шаблона, в котором определён указанный контракт. Если параметр не указан, используется текущая схема.
type string / обязательный	Тип контракта. Варианты: `"consumer"` `"provider"`
contracts list / элементы=dictionary	Список контрактов, связанных с этой EPG. Этот параметр нельзя использовать вместе с параметром `contract`. При использовании с `force_replace=true` все настроенные контракты будут заменены указанными. При использовании с `force_replace=false` будут добавлены, обновлены или удалены только указанные контракты. При использовании вместе с `state=query` должны быть найдены все указанные контракты; в противном случае задача завершится с ошибкой.
name string / обязательный	Имя контракта.
schema string	Имя схемы, в которой определён указанный контракт. Если параметр не указан, используется текущая схема.
template string	Имя шаблона, в котором определён указанный контракт. Если параметр не указан, используется текущая схема.
type string / обязательный	Тип контракта. Варианты: `"consumer"` `"provider"`
epg string / обязательный	Имя EPG.
force_replace boolean	Заменяет все настроенные контракты указанными. Этот параметр можно использовать только вместе с параметром `contracts`. При использовании вместе с `state=absent` и без настроенных контрактов все настроенные статические порты будут удалены. Варианты: `false` `true`
host псевдонимы: hostname string	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_HOST`.
login_domain string	Имя домена для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
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`.
schema string / обязательный	Имя схемы.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
template string / обязательный	Имя шаблона.
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`.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Значение `false` следует задавать только для сайтов под личным управлением, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Этот модуль разработан для Multi Site Orchestrator версии 2.1 или новее. Некоторые или все его функции могут не работать в более ранних версиях.

См. также

cisco.mso.mso_schema_template_anp_epg: Управление группами конечных точек (EPG) в шаблонах схем.
cisco.mso.mso_schema_template_contract_filter: Управление фильтрами контрактов в шаблонах схем.

Примеры

- name: Add a contract to an EPG
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contract:
      name: Contract 1
      type: consumer
    state: present

- name: Add 2 contracts to an EPG
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contracts:
      - name: Contract 1
        type: provider
      - name: Contract 1
        type: consumer
    state: present

- name: Replace all existing contracts on an EPG with 2 new contracts
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    force_replace: true
    contracts:
      - name: Contract 2
        type: provider
      - name: Contract 2
        type: consumer
    state: present

- name: Query a specific Contract
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contract:
      name: Contract 1
      type: consumer
    state: query
  register: query_result

- name: Query a list of Contracts
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contracts:
      - name: Contract 2
        type: provider
      - name: Contract 2
        type: consumer
    state: query
  register: query_result

- name: Query all Contracts
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    state: query
  register: query_result

- name: Remove a Contract
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contract:
      name: Contract 1
    state: absent

- name: Remove 2 contracts to an EPG
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    contracts:
      - name: Contract 1
        type: provider
      - name: Contract 1
        type: consumer
    state: absent

- name: Remove all existing contracts from an EPG
  cisco.mso.mso_schema_template_anp_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    force_replace: true
    state: absent

Авторы

Dag Wieers (@dagwieers)
Akini Ross (@akinross)

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

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