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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

APIC не предоставляет механизм для именования моментальных снимков.
Файлы моментальных снимков используют следующий формат именования: ce_<имя политики экспорта конфигурации>-<гггг>-<мм>-<дд>T<чч>:<мм>:<сс>+<чч>:<мм>.
Объекты моментальных снимков используют следующий формат именования: run-<гггг>-<мм>-<дд>T<чч>-<мм>-<сс>.
Дополнительную информацию об внутренних классах APIC config:Snapshot и config:ExportP можно найти в справочнике по модели управления информацией APIC.
Для получения более подробной информации о том, как управлять вашей инфраструктурой ACI с помощью Ansible, см. Руководство по Cisco ACI.

Примеры

- 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': {'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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Jacob McGill (@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.6/modules/aci_config_snapshot_module.html