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

Новое в версии 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name	Значение по умолчанию: C(private_key) basename	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию используется `private_key` basename без расширения. Псевдонимы: cert_name
description		Описание политики экспорта конфигурации. Псевдонимы: descr
export_policy		Имя политики экспорта для использования с моментальными снимками конфигурации. Псевдонимы: name
format	Варианты: json ← xml	Устанавливает формат резервной копии конфигурации в JSON или XML. APIC по умолчанию устанавливает новые политики экспорта в `json`
host обязательно		IP-адрес или имя хоста APIC, разрешимые для хоста управления Ansible. Псевдонимы: hostname
include_secure	Варианты: no yes ←	Определяет, должна ли защищенная информация включаться в резервную копию. APIC по умолчанию устанавливает новые политики экспорта в `yes`.
max_count	Варианты: Диапазон от 1 до 10 Значение по умолчанию: 3	Определяет, сколько снимков может существовать для политики экспорта, прежде чем APIC начнет переносить их. APIC по умолчанию устанавливает новые политики экспорта в `3`.
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` означает информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` означает отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password обязательно		Пароль для аутентификации.
port	Значение по умолчанию: 443 (для https) и 80 (для http)	Номер порта для подключения REST.
private_key		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `certificate_name`. Псевдонимы: cert_key
snapshot		Имя снимка для удаления.
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
timeout	Значение по умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl	Варианты: no yes ←	Если `no`, будет использоваться соединение HTTP вместо стандартного соединения HTTPS.
username обязательно	Значение по умолчанию: admin	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить только в `no` на сайтах с собственными сертификатами, находящимися под личным контролем.

Примечания

Примечание

APIC не предоставляет механизма для именования снимков.
Файлы снимков используют следующую структуру именования: ce_<имя политики экспорта конфигурации>-<гггг>-<мм>-<дд>T<чч>:<мм>:<сс>.<мсс>+<чч>:<мм>.
Объекты снимков используют следующую структуру именования: run-<гггг>-<мм>-<дд>T<чч>-<мм>-<сс>.
Дополнительную информацию о внутренних классах APIC config:Snapshot и config:ExportP можно найти в справочнике по модели управления информацией APIC.
По умолчанию, если на целевом узле установлена переменная среды <protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. настройки среды) или используя параметр use_proxy.
Перенаправления HTTP могут перенаправлять с HTTP на HTTPS, поэтому необходимо убедиться, что ваша среда прокси для обоих протоколов правильная.

Примеры

- name: Create a Snapshot
  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.

- name: Query all Snapshots
  aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

- name: Query Snapshots associated with a particular Export Policy
  aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
    export_policy: config_backup

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

Возвращаемые значения

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

Ключ	Возвращено	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая APIC Пример: {'text': 'неизвестный класс управляемого объекта foo', 'code': '122'}
filter_string строка	ошибка или отладка	Строка фильтра, использованная для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, использованный для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производство', 'nameAlias': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращённый APIC REST API (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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

Яков Макгилл (@jmcgill298)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/aci_config_snapshot_module.html