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

Примечание

Этот плагин входит в состав коллекции cisco.mso (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install cisco.mso

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

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

Описание

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

Требования

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

Multi Site Orchestrator версии 2.1 или более поздней

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
content raw		Устанавливает содержимое запроса API напрямую. Это может быть удобно для шаблонизации простых запросов. Для сложных запросов используйте плагин поиска `template` (см. примеры). псевдонимы: payload
host строка / обязательно		IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, используется значение переменной окружения `MSO_HOST`. псевдонимы: hostname
login_domain строка		Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, используется значение переменной окружения `MSO_LOGIN_DOMAIN`.
method строка	Варианты: delete get ← post put patch	HTTP-метод запроса. Использование `delete` обычно используется для удаления объектов. Использование `get` обычно используется для запроса объектов. Использование `post` обычно используется для изменения объектов. Использование `put` обычно используется для изменения существующих объектов. Использование `patch` также обычно используется для изменения существующих объектов. псевдонимы: action
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого ACI-модуля. `normal` означает стандартный вывод, включая `current` словарь `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, используется значение переменной окружения `MSO_OUTPUT_LEVEL`.
password строка / обязательно		Пароль для аутентификации. Если значение не указано в задаче, используется значение переменных окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
path строка / обязательно		URI, используемый для выполнения вызовов API. псевдонимы: uri
port целое число		Номер порта, используемого для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `MSO_PORT`.
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `MSO_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Если значение не указано в задаче, используется значение переменной окружения `MSO_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использовано HTTP-соединение. Если значение не указано в задаче, используется значение переменной окружения `MSO_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с лично контролируемыми сайтами, использующими самозаверяющие сертификаты. Если значение не указано в задаче, используется значение переменной окружения `MSO_VALIDATE_CERTS`.

Примечания

Примечание

Большинство полезных нагрузок не являются идемпотентными, поэтому будьте внимательны при построении полезных нагрузок.
Для получения более подробной информации о том, как управлять вашей инфраструктурой ACI с помощью Ansible, обратитесь к руководству Руководство Cisco ACI.
Этот модуль был написан для поддержки ACI Multi Site Orchestrator версии 2.1 или более поздней. Некоторые или все функции могут не работать на более ранних версиях.

См. также

cisco.mso.mso_tenant: Официальная документация по модулю 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
      }
  delegate_to: localhost

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

- 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
  delegate_to: localhost

- 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') }}"
  delegate_to: localhost

Авторы

Anvitha Jain (@anvitha-jain)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_rest_module.html