Модуль cisco.mso.mso_rest — прямой доступ к REST API Cisco MSO

Примечание

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

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

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

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

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

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

Обеспечивает управление фабрикой Cisco MSO посредством прямого доступа к REST API Cisco MSO.
Этот модуль не является идемпотентным и не сообщает об изменениях.

Требования

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

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

Параметры

Параметр	Комментарии
content псевдонимы: payload любой	Напрямую задаёт содержимое запроса API. Это может быть удобно для шаблонизации простых запросов. Для сложных запросов используйте модуль поиска `template` (см. примеры).
host псевдонимы: hostname строка	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_HOST`.
login_domain строка	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
method псевдонимы: action строка	Метод HTTP-запроса. Обычно `delete` используется для удаления объектов. Обычно `get` используется для запроса объектов. Обычно `post` используется для изменения объектов. Обычно `put` используется для изменения существующих объектов. Обычно `patch` также используется для изменения существующих объектов. Варианты: `"delete"` `"get"` ← (по умолчанию) `"post"` `"put"` `"patch"`
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`.
path псевдонимы: uri строка / обязательный	URI, используемый для выполнения вызовов API.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_PORT`.
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`. При использовании плагина подключения HTTPAPI (mso или nd) значение по умолчанию — `false`, а при использовании устаревшего метода подключения (только для mso) — `true`. Варианты: `false` `true`
username строка	Имя пользователя, используемое для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте значение `false` только на сайтах под личным управлением, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

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

См. также

cisco.mso.mso_tenant: Управление арендаторами.

Примеры

- name: Add schema (JSON)
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: /mso/api/v1/schemas
    method: post
    content:
      {
        "displayName": "{{ mso_schema | default('ansible_test') }}",
        "templates": [{
          "name": "Template_1",
          "tenantId": "{{ add_tenant.jsondata.id }}",
          "displayName": "Template_1",
          "templateSubType": [],
          "templateType": "stretched-template",
          "anps": [],
          "contracts": [],
          "vrfs": [],
          "bds": [],
          "filters": [],
          "externalEpgs": [],
          "serviceGraphs": [],
          "intersiteL3outs": []
        }],
        "sites": [],
        "_updateVersion": 0
      }

- name: Query schema
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: /mso/api/v1/schemas
    method: get
  register: query_result

- name: Patch schema (YAML)
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    path: "/mso/api/v1/schemas/{{ add_schema.jsondata.id }}"
    method: patch
    content:
      - op: add
        path: /templates/Template_1/anps/-
        value:
          name: AP2
          displayName: AP2
          epgs: []
        _updateVersion: 0

- name: Add a tenant from a templated payload file from templates
  cisco.mso.mso_rest:
    host: mso
    username: admin
    password: SomeSecretPassword
    method: post
    path: /api/v1/tenants
    content: "{{ lookup('template', 'mso/tenant.json.j2') }}"

Авторы

Anvitha Jain (@anvitha-jain)

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

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