cisco.ise.backup_config – Resource module for Backup Config

Note

This plugin is part of the cisco.ise collection (version 0.0.9).

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.backup_config.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource Backup Config.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk

Parameters

Parameter Choices/Defaults Comments
backupEncryptionKey
string
The encyption key for the backed up file. Encryption key must satisfy the following criteria - Contains at least one uppercase letter A-Z, Contains at least one lowercase letter a-z, Contains at least one digit 0-9, Contain only A-Za-z0-9_#, Has at least 8 characters, Has not more than 15 characters, Must not contain 'CcIiSsCco', Must not begin with.
backupName
string
The backup file will get saved with this name.
repositoryName
string
Name of the repository where the generated backup file will get copied.

See Also

See also

cisco.ise.plugins.module_utils.definitions.backup_config

The official documentation on the cisco.ise.plugins.module_utils.definitions.backup_config module.

Backup Config reference

Complete reference of the Backup Config object model.

Examples

- name: Create
  cisco.ise.backup_config:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupEncryptionKey: string
    backupName: string
    repositoryName: string

Return Values

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

Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "response": { "id": "string", "message": "string", "link": { "rel": "string", "href": "string", "type": "string" } }, "version": "string" }


Authors

  • Rafael Campos (@racampos)