Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 4.19 KB

fortiswitch_execute_backup_standalone_config.rst

File metadata and controls

92 lines (60 loc) · 4.19 KB
Raw
source:fortiswitch_execute_backup_standalone_config.py
orphan:

fortiswitch_execute_backup_standalone_config -- Backup Switch's Standalone Configuration.

.. versionadded:: 1.0.0

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify backup feature and standalone_config category. Examples include all parameters and values need to be adjusted to datasources before usage.

Requirements

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

  • ansible>=2.14

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • execute_backup_standalone_config - Backup Switch's Standalone Configuration. type: dict
    • config - Configuration"s Chunked String. type: str

Examples

- name: Backup Switch's Standalone Configuration.
  fortinet.fortiswitch.execute_backup_standalone_config:
      backup_standalone_config:
          config: "<your_own_value>"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
  • results - the main output of the execution returned: only for successful calls type: str

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.