W3cubDocs

/Ansible

aci_config_snapshot - Manage Config Snapshots on Cisco ACI fabrics (config:Snapshot, config:ExportP)

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis

Manage Config Snapshots on Cisco ACI fabrics.
Creating new Snapshots is done using the configExportP class.
Removing Snapshots is done using the configSnapshot class.
More information from the internal APIC classes config:Snapshot at https://developer.cisco.com/media/mim-ref/MO-configSnapshot.html and config:ExportP at https://developer.cisco.com/media/mim-ref/MO-configExportP.html.

Requirements (on host that executes module)

Tested with ACI Fabric 1.0(3f)+

Options

parameter	required	default	choices	comments
description	no			The description for the Config Export Policy. aliases: descr
export_policy	no			The name of the Export Policy to use for Config Snapshots. aliases: name
format	no	json	json xml	Sets the config backup to be formatted in JSON or XML. The APIC defaults new Export Policies to `json`
hostname	yes			IP Address or hostname of APIC resolvable by Ansible control host. aliases: host
include_secure	no	yes	no yes	Determines if secure information should be included in the backup. The APIC defaults new Export Policies to `yes`.
max_count	no	3	range between 1 and 10	Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover. The APIC defaults new Export Policies to `3`.
password	yes			The password to use for authentication.
snapshot	no			The name of the snapshot to delete.
state	no	present	absent present query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
timeout	no	30		The socket level timeout in seconds.
use_proxy	no	yes	yes no	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl	no	yes	yes no	If `no`, an HTTP connection will be used instead of the default HTTPS connection.
username	yes	admin		The username to use for authentication. aliases: user
validate_certs	no	yes	yes no	If `no`, SSL certificates will not be validated. This should only set to `no` used on personally controlled sites using self-signed certificates.

Examples

- name: Create a Snapshot
  aci_config_snapshot:
    hostname: 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:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    state: query

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

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

Notes

Note

The APIC does not provide a mechanism for naming the snapshots.
Snapshot files use the following naming structure: ce_<config export policy name>-<yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>.<mss>+<hh>:<mm>.
Snapshot objects use the following naming structure: run-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>.
By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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