fadcos_backup_config – Download FortiADC config file in Fortinet’s FortiADC¶
New in version 1.0.0.
FortiADC Version Compatibility¶
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.1.0 |
v7.1.4 |
v7.2.2 |
v7.4.0 |
|
| fortiadc_backup_config | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- action - Type of action to perform on the object. type: str required: true
- path - The config file save pathtype: str required: false
- name - The config file save nametype: str required: false
- configtype - The backup typetype: str required: false default: local
- password - The config file unzip passwordtype: str required: false
- action=download and type=local (default) - will download current config to local PC.
- action=save and name= xxx - will backup current config and save it to ADC backup config list as name of xxx.
- action=download and type=adc and name=xxx - will be download config with specified config name:xxx from the adc backup config list.
Examples¶
- name:
hosts: all
connection: httpapi
gather_facts: false
tasks:
- name: Backup config
fadcos_backup_config:
action: save
path: /temp/fortiadc/.
password: pwd
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 200 - OK: Request returns successful.
- 400 - Bad Request: Request cannot be processed by the API.
- 401 - Not Authorized: Request without successful login session.
- 403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
- 404 - Resource Not Found: Unable to find the specified resource.
- 405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
- 413 - Request Entity Too Large: Request cannot be processed due to large entity.
- 424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
- 429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
- 500 - Internal Server Error: Internal error when processing the request.
For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/