aci_config_snapshot – Manage Config Snapshots (config:Snapshot, config:ExportP)

New in version 2.4.

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.

Parameters

Parameter Choices/Defaults Comments
certificate_name
string
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
If a private_key filename was provided, this defaults to the private_key basename, without extension.
If PEM-formatted content was provided for private_key, this defaults to the username value.

aliases: cert_name
description
string
The description for the Config Export Policy.

aliases: descr
export_policy
string
The name of the Export Policy to use for Config Snapshots.

aliases: name
format
string
    Choices:
  • json
  • xml
Sets the config backup to be formatted in JSON or XML.
The APIC defaults to json when unset.
host
string / required
IP Address or hostname of APIC resolvable by Ansible control host.

aliases: hostname
include_secure
boolean
    Choices:
  • no
  • yes
Determines if secure information should be included in the backup.
The APIC defaults to yes when unset.
max_count
integer
Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover.
Accepted values range between 1 and 10.
The APIC defaults to 3 when unset.
output_level
string
    Choices:
  • debug
  • info
  • normal ←
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info adds informational output, incl. previous, proposed and sent dicts
debug adds debugging output, incl. filter_string, method, response, status and url information
password
string / required
The password to use for authentication.
This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
port
integer
Port number to be used for REST connection.
The default value depends on parameter use_ssl.
private_key
string / required
Either a PEM-formatted private key file or the private key content used for signature-based authentication.
This value also influences the default certificate_name that is used.
This option is mutual exclusive with password. If password is provided too, it will be ignored.

aliases: cert_key
snapshot
string
The name of the snapshot to delete.
state
string
    Choices:
  • absent
  • present ←
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
timeout
integer
Default:
30
The socket level timeout in seconds.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
string
Default:
"admin"
The username to use for authentication.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.

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>.

See Also

See also

aci_config_rollback – Provides rollback and rollback preview functionality (config:ImportP)
The official documentation on the aci_config_rollback module.
APIC Management Information Model reference
More information about the internal APIC classes config:Snapshot and config:ExportP.
Cisco ACI ガイド
Detailed information on how to manage your ACI infrastructure using Ansible.
Cisco ACI モジュールの開発
Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
current
list
success
The existing configuration from the APIC after the module has finished

Sample:
[{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error
dictionary
failure
The error information as returned from the APIC

Sample:
{'code': '122', 'text': 'unknown managed object class foo'}
filter_string
string
failure or debug
The filter string used for the request

Sample:
?rsp-prop-include=config-only
method
string
failure or debug
The HTTP method used for the request to the APIC

Sample:
POST
previous
list
info
The original configuration from the APIC before the module has started

Sample:
[{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
dictionary
info
The assembled configuration from the user-provided parameters

Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
raw
string
parse error
The raw output returned by the APIC REST API (xml or json)

Sample:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response
string
failure or debug
The HTTP response from the APIC

Sample:
OK (30 bytes)
sent
list
info
The actual/minimal configuration pushed to the APIC

Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status
integer
failure or debug
The HTTP status from the APIC

Sample:
200
url
string
failure or debug
The HTTP url used for the request to the APIC

Sample:
https://10.11.12.13/api/mo/uni/tn-production.json


Status

Authors

  • Jacob McGill (@jmcgill298)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.