cisco.ise.backup_schedule_config_update module – Resource module for Backup Schedule Config Update
Note
This module is part of the cisco.ise collection (version 2.9.5).
To install it, use: ansible-galaxy collection install cisco.ise
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.backup_schedule_config_update
.
New in cisco.ise 2.0.0
Synopsis
Manage operation update of the resource Backup Schedule Config Update.
Update the Schedule of the configuration backup on the ISE node as per the input parameters. This API only helps in editing the schedule.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Description of the backup. |
|
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. |
|
The backup file will get saved with this name. |
|
End date of the scheduled backup job. Allowed format MM/DD/YYYY. End date is not required in case of ONE_TIME frequency. |
|
Backup Schedule Config Update’s frequency. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: :ansible-option-default:`60` |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: |
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Day of month you want backup to be performed on when scheduled frequency is MONTHLY. Allowed values - from 1 to 28. |
|
Name of the configured repository where the generated backup file will get copied. |
|
Start date for scheduling the backup job. Allowed format MM/DD/YYYY. |
|
Backup Schedule Config Update’s status. |
|
Time at which backup job get scheduled. Example- 12 00 AM. |
|
Backup Schedule Config Update’s weekDay. |
Notes
Note
SDK Method used are backup_and_restore.BackupAndRestore.update_scheduled_config_backup,
Paths used are put /api/v1/backup-restore/config/schedule-config-backup,
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
See Also
See also
- Cisco ISE documentation for Backup And Restore
Complete reference of the Backup And Restore API.
Examples
- name: Update all
cisco.ise.backup_schedule_config_update:
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
monthDay: string
repositoryName: string
startDate: string
status: string
time: string
weekDay: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |