cisco.ise.backup_schedule_config – Resource module for Backup Schedule 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_schedule_config.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource Backup Schedule 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
backupDescription
string
Description of the backup.
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.
endDate
string
End date of the scheduled backup job. Allowed format YYYY-MM-DD. End date is not required in case of ONE_TIME frequency.
frequency
string
Frequency with which the backup will get scheduled in the ISE node. Allowed values - ONE_TIME, DAILY, WEEKLY, MONTHLY.
repositoryName
string
Name of the repository where the generated backup file will get copied.
startDate
string
Start date for scheduling the backup job. Allowed format YYYY-MM-DD.
time
string
Time at which backup job get scheduled. Example- 12 00 AM.

See Also

See also

cisco.ise.plugins.module_utils.definitions.backup_schedule_config

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

Backup Schedule Config reference

Complete reference of the Backup Schedule Config object model.

Examples

- name: Create
  cisco.ise.backup_schedule_config:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupDescription: string
    backupEncryptionKey: string
    backupName: string
    endDate: string
    frequency: string
    repositoryName: string
    startDate: string
    time: 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": { "message": "string", "link": { "rel": "string", "href": "string", "type": "string" } }, "version": "string" }


Authors

  • Rafael Campos (@racampos)