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

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.mso.mso_rest.

Обзор
Требования
Параметры
Примечания
См. также
Примеры

Обзор

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

Требования

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

Multi Site Orchestrator v2.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` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `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` будет использоваться, если этот атрибут не указан. Значение по умолчанию — `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`

Примечания

Примечание

Большинство полезных нагрузок не являются идемпотентными, поэтому будьте осторожны при их построении.
Этот модуль был написан для поддержки Multi Site Orchestrator v2.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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_rest_module.html