Модуль cisco.mso.mso_schema_template_anp_epg_annotation — управление аннотациями EPG в 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.mso_schema_template_anp_epg_annotation.

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

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

Управление аннотациями групп конечных точек (EPG) в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v3.0 (NDO v4.2) и более поздних версиях.

Требования

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

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
annotation_key псевдонимы: key строка	Ключ объекта Annotation.
annotation_value псевдонимы: value строка	Значение объекта Annotation.
anp строка / обязательный	Имя профиля сети приложений (ANP).
epg строка / обязательный	Имя EPG, которой нужно управлять.
host псевдонимы: hostname строка	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_HOST`.
login_domain строка	Имя домена входа, используемое для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаризации `ansible_httpapi_login_domain`.
output_level строка	Управляет выводом этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password строка	Пароль, используемый для аутентификации. Если значение не указано в задаче, вместо него используются значения переменных окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_PORT`.
schema строка / обязательный	Имя схемы.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
template строка / обязательный	Имя шаблона.
timeout целое число	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_TIMEOUT`.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо соединения HTTPS по умолчанию будет использоваться соединение HTTP. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаризации `ansible_httpapi_use_ssl`. По умолчанию используется `false` при работе с подключаемым модулем соединения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода соединения (только для mso). Варианты: `false` `true`
username строка	Имя пользователя, используемое для аутентификации. Если значение не указано в задаче, вместо него используются значения переменных окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если `false`, проверка SSL-сертификатов выполняться не будет. Это значение следует устанавливать в `false` только на контролируемых пользователем сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должны существовать schema, template, anp и epg. Используйте cisco.mso.mso_schema_template, чтобы создать схему и шаблон. Используйте cisco.mso.mso_schema_template_anp, чтобы создать ANP. Используйте cisco.mso.mso_schema_template_anp_epg, чтобы создать EPG.
Этот модуль создан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.mso_schema_template: Управление шаблонами в схемах.
cisco.mso.mso_schema_template_anp: Управление профилями сети приложений (ANP) в шаблонах схем.
cisco.mso.mso_schema_template_anp_epg: Управление группами конечных точек (EPG) в шаблонах схем.

Примеры

- name: Add an annotation with key and value
  cisco.mso.mso_schema_template_anp_epg_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    annotation_key: annotation_key_1
    annotation_value: annotation_value_1
    state: present

- name: Update an annotation value with key
  cisco.mso.mso_schema_template_anp_epg_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    annotation_key: annotation_key_1
    annotation_value: annotation_value_1_updated
    state: present

- name: Query a specific annotation with key
  cisco.mso.mso_schema_template_anp_epg_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    annotation_key: annotation_key_1
    state: query
  register: query_one

- name: Query all annotations
  cisco.mso.mso_schema_template_anp_epg_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    state: query
  register: query_all

- name: Delete an annotation
  cisco.mso.mso_schema_template_anp_epg_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    annotation_key: annotation_key_1
    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/mso_schema_template_anp_epg_annotation_module.html