Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_config_rollback – Обеспечивает функциональность отката и предварительного просмотра отката (config:ImportP)

Примечание

Этот модуль является частью коллекции cisco.aci (версия 2.10.1).

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

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

Для использования в playbook укажите: cisco.aci.aci_config_rollback.

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

Обзор

  • Обеспечивает функциональность отката и предварительного просмотра отката для Cisco ACI fabric.
  • Откаты конфигурации выполняются с использованием снимков aci_snapshot с помощью класса configImportP.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

annotation

строка

Пользовательская строка для аннотирования объекта.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче и переменной среды ACI_ANNOTATION, то будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

строка

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если был предоставлен файл с именем private_key, значение по умолчанию — это имя файла private_key, без расширения.

Если для private_key был предоставлен контент в формате PEM, значение по умолчанию — username.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

compare_export_policy

строка

Политика экспорта, к которой относится compare_snapshot.

compare_snapshot

строка

Имя моментального снимка для сравнения с snapshot.

description

псевдонимы: descr

строка

Описание политики импорта.

export_policy

строка

Политика экспорта, к которой относится snapshot.

fail_on_decrypt

логическое

Определяет, должен ли APIC прервать выполнение отката, если не удаётся расшифровать защищённые данные.

APIC по умолчанию устанавливает значение true при отсутствии явного значения.

Варианты:

  • false
  • true

host

псевдонимы: hostname

строка

IP-адрес или имя хоста APIC, разрешаемое хостом Ansible.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.

import_mode

строка

Определяет, как APIC должен обработать импорт.

APIC по умолчанию устанавливает значение atomic при отсутствии явного значения.

Варианты:

  • "atomic"
  • "best-effort"

import_policy

строка

Имя политики импорта, используемой для отката конфигурации.

...
END_OF_DOCUMENT_MARKER

snapshot

строка / обязательно

Имя моментального снимка, к которому нужно выполнить откат, или базовый моментальный снимок для сравнения.

Модуль aci_snapshot может быть использован для запроса списка доступных моментальных снимков.

state

строка

Используйте preview для предварительного просмотра разницы между двумя моментальными снимками.

Используйте rollback для восстановления конфигурации до предыдущего моментального снимка.

Варианты:

  • "preview"
  • "rollback" ← (по умолчанию)

suppress_previous

псевдонимы: no_previous, ignore_previous

логический

Если true, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к пустому значению предыдущего возвращаемого значения.

Предыдущее состояние объекта не будет проверяться, а обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логический

Если true, проверяющий GET-запрос не будет отправлен после обновления POST в APIC.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче.

Варианты:

  • false
  • true

timeout

целое число

Таймаут уровня сокета в секундах.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_TIMEOUT.

Значение по умолчанию 30.

use_proxy

логический

Если false, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_USE_PROXY.

Значение по умолчанию true.

Варианты:

  • false
  • true

use_ssl

логический

Если false, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_USE_SSL.

Значение по умолчанию true, когда соединение локальное.

Варианты:

  • false
  • true

username

псевдонимы: user

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будет использовано значение переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию admin.

validate_certs

логический

Если false, сертификаты SSL не будут проверяться.

Это должно быть установлено в false только при использовании на сайтах с собственной подписью сертификатов.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_VALIDATE_CERTS.

Значение по умолчанию true.

Варианты:

  • false
  • true

Примечания

Примечание

  • Сильно рекомендуется добавить задачу паузы после создания моментального снимка.
  • Дождитесь завершения создания моментального снимка перед запросом, сравнением моментальных снимков или обработкой откатов.

См. также

См. также

cisco.aci.aci_config_snapshot

Управление моментальными снимками конфигурации (config:Snapshot и config:ExportP).

APIC Management Information Model reference

Дополнительная информация об внутренней классе APIC config:ImportP.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для вклада.

Примеры

---
- name: Create a Snapshot
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    state: present
  delegate_to: localhost

- name: Wait for snapshot to be finished before querying
  pause:
    seconds: 10

- name: Query Existing Snapshots
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    state: query
  delegate_to: localhost

- name: Compare Snapshot Files
  cisco.aci.aci_config_rollback:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    snapshot: run-2017-08-28T06-24-01
    compare_export_policy: config_backup
    compare_snapshot: run-2017-08-27T23-43-56
    state: preview
  delegate_to: localhost

- name: Rollback Configuration
  cisco.aci.aci_config_rollback:
    host: apic
    username: admin
    password: SomeSecretPassword
    import_policy: rollback_config
    export_policy: config_backup
    snapshot: run-2017-08-28T06-24-01
    state: rollback
  delegate_to: localhost

- name: Rollback Configuration
  cisco.aci.aci_config_rollback:
    host: apic
    username: admin
    password: SomeSecretPassword
    import_policy: rollback_config
    export_policy: config_backup
    snapshot: run-2017-08-28T06-24-01
    description: Rollback 8-27 changes
    import_mode: atomic
    import_type: replace
    fail_on_decrypt: true
    state: rollback
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

error

словарь

Информация об ошибке, возвращённая APIC

Возвращается: ошибка

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

строка

Строка фильтра, используемая для запроса

Возвращается: ошибка или отладка

Пример: "?rsp-prop-include=config-only"

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращается: ошибка или отладка

Пример: "POST"

preview

строка

Предварительный просмотр между двумя моментами создания снимков

Возвращается: при состоянии preview

raw

строка

Необработанный вывод, возвращённый API REST APIC (xml или json)

Возвращается: ошибка разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

строка

HTTP-ответ от APIC

Возвращается: ошибка или отладка

Пример: "OK (30 bytes)"

status

целое число

HTTP-статус от APIC

Возвращается: ошибка или отладка

Пример: 200

url

строка

HTTP-URL, используемый для запроса к APIC

Возвращается: ошибка или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Jacob McGill (@jmcgill298)
  • Gaspard Micol (@gmicol)

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

  • Отслеживание задач
  • Репозиторий (источники)

© 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/aci/aci_config_rollback_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API