cisco.ise.backup_restore – Resource module for Backup Restore

Note

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

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource Backup Restore.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.0.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
backupEncryptionKey
string
The encryption key which was provided at the time of taking backup.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.0.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
repositoryName
string
Name of the configred repository where the backup file exists.
restoreFile
string
Name of the backup file to be restored on ISE node.
restoreIncludeAdeos
string
Determines whether the ADE-OS configure is restored. Possible values true, false.

Notes

Note

  • Does not support check_mode

See Also

See also

Backup Restore reference

Complete reference of the Backup Restore object model.

Examples

- name: Create
  cisco.ise.backup_restore:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupEncryptionKey: string
    repositoryName: string
    restoreFile: string
    restoreIncludeAdeos: 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)