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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
annotation_key aliases: key string	Ключ объекта Annotation.
annotation_value aliases: value string	Значение объекта Annotation.
host aliases: hostname string	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
l3out aliases: l3out_name string / обязательный	Имя L3Out.
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`.
state string	Используйте `absent` для удаления. Используйте `query` для вывода одного или нескольких объектов. Используйте `present` для создания или обновления. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template aliases: l3out_template string / обязательный	Имя шаблона. Это должен быть шаблон L3Out.
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`, если этот атрибут не указан. При использовании подключаемого модуля соединения HTTPAPI (mso или nd) значение по умолчанию — `false`, а при использовании устаревшего метода соединения (только для mso) — `true`. Варианты: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если задано значение `false`, SSL-сертификаты не проверяются. Значение `false` следует задавать только на сайтах под личным контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

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

Примеры

- name: Add an annotation with key and value
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1"
    annotation_value: "annotation_value_1"
    state: present

- name: Update an annotation with value
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    annotation_value: "annotation_value_1"
    state: present

- name: Query a specific annotation with key
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    state: query
  register: query_one

- name: Query all annotations
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    state: query
  register: query_all

- name: Delete an annotation
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    state: absent

Авторы

Sabari Jaganathan (@sajagana)

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

© 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_l3out_annotation_module.html