Skip to content

Latest commit

 

History

History
311 lines (267 loc) · 13.2 KB

fortios_system_storage.rst

File metadata and controls

311 lines (267 loc) · 13.2 KB
Raw
source:fortios_system_storage.py
orphan:

fortios_system_storage -- Configure logical storage in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and storage category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_storage v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_storage - Configure logical storage. type: dict more...
    Supported Version Ranges
    system_storage v6.0.0 -> latest
    • device - Partition device. type: str more...
      Supported Version Ranges
      device v6.0.0 -> latest
    • media_status - The physical status of current media. type: str choices: enable, disable, fail more...
      Supported Version Ranges
      media_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [fail] v6.0.0 -> latest
    • name - Storage name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • order - Set storage order. type: int more...
      Supported Version Ranges
      order v6.0.0 -> latest
    • partition - Label of underlying partition. type: str more...
      Supported Version Ranges
      partition v6.0.0 -> latest
    • size - Partition size. type: int more...
      Supported Version Ranges
      size v6.0.0 -> latest
    • status - Enable/disable storage. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • usage - Use hard disk for logging or WAN Optimization . type: str choices: log, wanopt more...
      Supported Version Ranges
      usage v6.0.0 -> latest
      [log] v6.0.0 -> latest
      [wanopt] v6.0.0 -> latest
    • wanopt_mode - WAN Optimization mode . type: str choices: mix, wanopt, webcache more...
      Supported Version Ranges
      wanopt_mode v6.0.0 -> latest
      [mix] v6.0.0 -> latest
      [wanopt] v6.0.0 -> latest
      [webcache] v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure logical storage.
  fortinet.fortios.fortios_system_storage:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_storage:
          device: "<your_own_value>"
          media_status: "enable"
          name: "default_name_5"
          order: "0"
          partition: "<your_own_value>"
          size: "0"
          status: "enable"
          usage: "log"
          wanopt_mode: "mix"

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 fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • 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
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

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)
  • Nicolas Thomas (@thomnico)

Hint

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