Skip to content

Latest commit

 

History

History
206 lines (183 loc) · 11.6 KB

cisco.sastre.certificate_restore_module.rst

File metadata and controls

206 lines (183 loc) · 11.6 KB
source:certificate_restore.py
orphan:

certificate_restore -- Restore WAN edge certificate validity status to from a backup.

Synopsis

  • The certificate restore task can be used to restore WAN edge certificate validity status to the same values as in the provided backup. A regular expression can be used to select one or more WAN edges.

Parameters

Parameter Choices/Defaults Comments
address
string / required
vManage IP address or can also be defined via VMANAGE_IP environment variable
dryrun
boolean
    Choices:
  • no ←
  • yes
Dry-run mode. List modifications that would be performed without pushing changes to vManage.
not_regex
string
Regular expression selecting devices NOT to modify certificate status. Matches on the hostname or chassis/uuid.
password
string / required
password or can also be defined via VMANAGE_PASSWORD environment variable.
port
integer
Default:
8443
vManage port number or can also be defined via VMANAGE_PORT environment variable
regex
string
Regular expression selecting devices to modify certificate status. Matches on the hostname or chassis/uuid. Use "^-$" to match devices without a hostname.
tenant
string
tenant name, when using provider accounts in multi-tenant deployments.
timeout
integer
Default:
300
vManage REST API timeout in seconds
user
string / required
username or can also be defined via VMANAGE_USER environment variable.
workdir
string
Default:
"backup_\u003caddress\u003e_\u003cyyyymmdd\u003e"
Restore source. Directory in the local machine under 'data' where vManage backup is located. The 'data' directory is relative to the directory where Ansible script is run. By default, it follows the format "backup_<address>_<yyyymmdd>".

Notes

Note

  • Tested against 20.10

Examples

- name: Certificate restore
  cisco.sastre.certificate_restore:
    workdir: backup_198.18.1.10_20210720
    regex: "cedge_1"
    dryrun: True
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin
- name: Certificate restore
  cisco.sastre.certificate_restore:
    workdir: backup_198.18.1.10_20210720
    dryrun: True
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin