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

Примечание

Этот плагин является частью коллекции cisco.aci (версия 2.0.0).

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

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

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

Обзор

Управление моментальными снимками конфигурации на Cisco ACI сетях.
Создание новых снимков выполняется с использованием класса configExportP.
Удаление снимков выполняется с использованием класса configSnapshot.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, это значение по умолчанию равно имени файла `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, это значение по умолчанию равно значению `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание политики экспорта конфигурации. псевдонимы: descr
export_policy строка		Имя политики экспорта для использования в моментальных снимках конфигурации. псевдонимы: name
format строка	Варианты: json xml	Устанавливает формат резервной копии конфигурации в JSON или XML. APIC по умолчанию использует `json`, если не задано.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемого хостом Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
include_secure логическое значение	Варианты: no yes	Определяет, следует ли включать защищенную информацию в резервную копию. APIC по умолчанию использует `yes`, если не задано.
max_count целое число		Определяет, сколько снимков может существовать для политики экспорта, прежде чем APIC начнет перенос. Допустимые значения находятся в диапазоне от `1` до `10`. APIC по умолчанию использует `3`, если не задано.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку, позволяющую клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если предоставлено также `private_key`, оно будет использоваться вместо него. Если значение не указано в задаче, используются значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если также предоставлено `password`, оно будет проигнорировано. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
snapshot строка		Имя снимка для удаления.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка объекта или нескольких объектов.
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использовано HTTP-соединение. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используются значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с сайтами, контролируемыми лично, использующими самозаверенные сертификаты. Если значение не указано в задаче, используется значение переменной окружения `ACI_VALIDATE_CERTS`.

Примечания

Примечание

APIC не предоставляет механизм для именования снимков.
Файлы снимков используют следующую структуру именования: ce_<имя политики экспорта конфигурации>-<гггг>-<мм>-<дд>T<чч>:<мм>:<сс>+<чч>:<мм>.
Объекты снимков используют следующую структуру именования: run-<гггг>-<мм>-<дд>T<чч>-<мм>-<сс>.

См. также

cisco.aci.aci_config_rollback: Официальная документация по модулю cisco.aci.aci_config_rollback.
APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC config:Snapshot и config:ExportP.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a Snapshot
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: present
    export_policy: config_backup
    max_count: 10
    description: Backups taken before new configs are applied.
  delegate_to: localhost

- name: Query all Snapshots
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Snapshots associated with a particular Export Policy
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Snapshot
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    snapshot: run-2017-08-24T17-20-05
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Существующая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращенная с APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	Метод HTTP, используемый для запроса к APIC Пример: POST
previous список / элементы=строка	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращенный API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список / элементы=строка	информация	Фактическая/минимальная конфигурация, отправленная на APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус с APIC Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Jacob McGill (@jmcgill298)

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