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 логическое	Варианты: 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` информацию.
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 целое число	По умолчанию: 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.

См. также

Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей 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.
  delegate_to: localhost

- name: Query all Snapshots
  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
  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
  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

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается партнером 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.7/modules/aci_config_snapshot_module.html