Skip to content

Latest commit

 

History

History
1912 lines (1871 loc) · 79.4 KB

fortios_router_ospf6.rst

File metadata and controls

1912 lines (1871 loc) · 79.4 KB
Raw
source:fortios_router_ospf6.py
orphan:

fortios_router_ospf6 -- Configure IPv6 OSPF 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 router feature and ospf6 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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
  • router_ospf6 - Configure IPv6 OSPF. type: dict more...
    Supported Version Ranges
    router_ospf6 v6.0.0 -> 7.4.3
    • abr_type - Area border router type. type: str choices: cisco, ibm, standard more...
      Supported Version Ranges
      abr_type v6.0.0 -> 7.4.3
      [cisco] v6.0.0 -> 7.4.3
      [ibm] v6.0.0 -> 7.4.3
      [standard] v6.0.0 -> 7.4.3
    • area - OSPF6 area configuration. type: list member_path: area:id more...
      Supported Version Ranges
      area v6.0.0 -> 7.4.3
      • authentication - Authentication mode. type: str choices: none, ah, esp more...
        Supported Version Ranges
        authentication v6.2.0 -> 7.4.3
        [none] v6.2.0 -> 7.4.3
        [ah] v6.2.0 -> 7.4.3
        [esp] v6.2.0 -> 7.4.3
      • default_cost - Summary default cost of stub or NSSA area. type: int more...
        Supported Version Ranges
        default_cost v6.0.0 -> 7.4.3
      • id - Area entry IP address. type: str required: true more...
        Supported Version Ranges
        id v6.0.0 -> 7.4.3
      • ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
        Supported Version Ranges
        ipsec_auth_alg v6.2.0 -> 7.4.3
        [md5] v6.2.0 -> 7.4.3
        [sha1] v6.2.0 -> 7.4.3
        [sha256] v6.2.0 -> 7.4.3
        [sha384] v6.2.0 -> 7.4.3
        [sha512] v6.2.0 -> 7.4.3
      • ipsec_enc_alg - Encryption algorithm. type: str choices: null, des, 3des, aes128, aes192, aes256 more...
        Supported Version Ranges
        ipsec_enc_alg v6.2.0 -> 7.4.3
        [null] v6.2.0 -> 7.4.3
        [des] v6.2.0 -> 7.4.3
        [3des] v6.2.0 -> 7.4.3
        [aes128] v6.2.0 -> 7.4.3
        [aes192] v6.2.0 -> 7.4.3
        [aes256] v6.2.0 -> 7.4.3
      • ipsec_keys - IPsec authentication and encryption keys. type: list member_path: area:id/ipsec_keys:spi more...
        Supported Version Ranges
        ipsec_keys v6.2.0 -> 7.4.3
        • auth_key - Authentication key. type: str more...
          Supported Version Ranges
          auth_key v6.2.0 -> 7.4.3
        • enc_key - Encryption key. type: str more...
          Supported Version Ranges
          enc_key v6.2.0 -> 7.4.3
        • spi - Security Parameters Index. see Notes. type: int required: true more...
          Supported Version Ranges
          spi v6.2.0 -> 7.4.3
      • key_rollover_interval - Key roll-over interval. type: int more...
        Supported Version Ranges
        key_rollover_interval v6.2.0 -> 7.4.3
      • nssa_default_information_originate - Enable/disable originate type 7 default into NSSA area. type: str choices: enable, disable more...
        Supported Version Ranges
        nssa_default_information_originate v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
      • nssa_default_information_originate_metric - OSPFv3 default metric. type: int more...
        Supported Version Ranges
        nssa_default_information_originate_metric v6.0.0 -> 7.4.3
      • nssa_default_information_originate_metric_type - OSPFv3 metric type for default routes. type: str choices: 1, 2 more...
        Supported Version Ranges
        nssa_default_information_originate_metric_type v6.0.0 -> 7.4.3
        [1] v6.0.0 -> 7.4.3
        [2] v6.0.0 -> 7.4.3
      • nssa_redistribution - Enable/disable redistribute into NSSA area. type: str choices: enable, disable more...
        Supported Version Ranges
        nssa_redistribution v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
      • nssa_translator_role - NSSA translator role type. type: str choices: candidate, never, always more...
        Supported Version Ranges
        nssa_translator_role v6.0.0 -> 7.4.3
        [candidate] v6.0.0 -> 7.4.3
        [never] v6.0.0 -> 7.4.3
        [always] v6.0.0 -> 7.4.3
      • range - OSPF6 area range configuration. type: list member_path: area:id/range:id more...
        Supported Version Ranges
        range v6.0.0 -> 7.4.3
        • advertise - Enable/disable advertise status. type: str choices: disable, enable more...
          Supported Version Ranges
          advertise v6.0.0 -> 7.4.3
          [disable] v6.0.0 -> 7.4.3
          [enable] v6.0.0 -> 7.4.3
        • id - Range entry ID. see Notes. type: int required: true more...
          Supported Version Ranges
          id v6.0.0 -> 7.4.3
        • prefix6 - IPv6 prefix. type: str more...
          Supported Version Ranges
          prefix6 v6.0.0 -> 7.4.3
      • stub_type - Stub summary setting. type: str choices: no-summary, summary more...
        Supported Version Ranges
        stub_type v6.0.0 -> 7.4.3
        [no-summary] v6.0.0 -> 7.4.3
        [summary] v6.0.0 -> 7.4.3
      • type - Area type setting. type: str choices: regular, nssa, stub more...
        Supported Version Ranges
        type v6.0.0 -> 7.4.3
        [regular] v6.0.0 -> 7.4.3
        [nssa] v6.0.0 -> 7.4.3
        [stub] v6.0.0 -> 7.4.3
      • virtual_link - OSPF6 virtual link configuration. type: list member_path: area:id/virtual_link:name more...
        Supported Version Ranges
        virtual_link v6.0.0 -> 7.4.3
        • authentication - Authentication mode. type: str choices: none, ah, esp, area more...
          Supported Version Ranges
          authentication v6.2.0 -> 7.4.3
          [none] v6.2.0 -> 7.4.3
          [ah] v6.2.0 -> 7.4.3
          [esp] v6.2.0 -> 7.4.3
          [area] v6.2.0 -> 7.4.3
        • dead_interval - Dead interval. type: int more...
          Supported Version Ranges
          dead_interval v6.0.0 -> 7.4.3
        • hello_interval - Hello interval. type: int more...
          Supported Version Ranges
          hello_interval v6.0.0 -> 7.4.3
        • ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
          Supported Version Ranges
          ipsec_auth_alg v6.2.0 -> 7.4.3
          [md5] v6.2.0 -> 7.4.3
          [sha1] v6.2.0 -> 7.4.3
          [sha256] v6.2.0 -> 7.4.3
          [sha384] v6.2.0 -> 7.4.3
          [sha512] v6.2.0 -> 7.4.3
        • ipsec_enc_alg - Encryption algorithm. type: str choices: null, des, 3des, aes128, aes192, aes256 more...
          Supported Version Ranges
          ipsec_enc_alg v6.2.0 -> 7.4.3
          [null] v6.2.0 -> 7.4.3
          [des] v6.2.0 -> 7.4.3
          [3des] v6.2.0 -> 7.4.3
          [aes128] v6.2.0 -> 7.4.3
          [aes192] v6.2.0 -> 7.4.3
          [aes256] v6.2.0 -> 7.4.3
        • ipsec_keys - IPsec authentication and encryption keys. type: list member_path: area:id/virtual_link:name/ipsec_keys:spi more...
          Supported Version Ranges
          ipsec_keys v6.2.0 -> 7.4.3
          • auth_key - Authentication key. type: str more...
            Supported Version Ranges
            auth_key v6.2.0 -> 7.4.3
          • enc_key - Encryption key. type: str more...
            Supported Version Ranges
            enc_key v6.2.0 -> 7.4.3
          • spi - Security Parameters Index. see Notes. type: int required: true more...
            Supported Version Ranges
            spi v6.2.0 -> 7.4.3
        • key_rollover_interval - Key roll-over interval. type: int more...
          Supported Version Ranges
          key_rollover_interval v6.2.0 -> 7.4.3
        • name - Virtual link entry name. type: str required: true more...
          Supported Version Ranges
          name v6.0.0 -> 7.4.3
        • peer - A.B.C.D, peer router ID. type: str more...
          Supported Version Ranges
          peer v6.0.0 -> 7.4.3
        • retransmit_interval - Retransmit interval. type: int more...
          Supported Version Ranges
          retransmit_interval v6.0.0 -> 7.4.3
        • transmit_delay - Transmit delay. type: int more...
          Supported Version Ranges
          transmit_delay v6.0.0 -> 7.4.3
    • auto_cost_ref_bandwidth - Reference bandwidth in terms of megabits per second. type: int more...
      Supported Version Ranges
      auto_cost_ref_bandwidth v6.0.0 -> 7.4.3
    • bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable more...
      Supported Version Ranges
      bfd v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • default_information_metric - Default information metric. type: int more...
      Supported Version Ranges
      default_information_metric v6.0.0 -> 7.4.3
    • default_information_metric_type - Default information metric type. type: str choices: 1, 2 more...
      Supported Version Ranges
      default_information_metric_type v6.0.0 -> 7.4.3
      [1] v6.0.0 -> 7.4.3
      [2] v6.0.0 -> 7.4.3
    • default_information_originate - Enable/disable generation of default route. type: str choices: enable, always, disable more...
      Supported Version Ranges
      default_information_originate v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [always] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • default_information_route_map - Default information route map. Source router.route-map.name. type: str more...
      Supported Version Ranges
      default_information_route_map v6.0.0 -> 7.4.3
    • default_metric - Default metric of redistribute routes. type: int more...
      Supported Version Ranges
      default_metric v6.0.0 -> 7.4.3
    • log_neighbour_changes - Log OSPFv3 neighbor changes. type: str choices: enable, disable more...
      Supported Version Ranges
      log_neighbour_changes v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • ospf6_interface - OSPF6 interface configuration. type: list member_path: ospf6_interface:name more...
      Supported Version Ranges
      ospf6_interface v6.0.0 -> 7.4.3
      • area_id - A.B.C.D, in IPv4 address format. type: str more...
        Supported Version Ranges
        area_id v6.0.0 -> 7.4.3
      • authentication - Authentication mode. type: str choices: none, ah, esp, area more...
        Supported Version Ranges
        authentication v6.2.0 -> 7.4.3
        [none] v6.2.0 -> 7.4.3
        [ah] v6.2.0 -> 7.4.3
        [esp] v6.2.0 -> 7.4.3
        [area] v6.2.0 -> 7.4.3
      • bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: global, enable, disable more...
        Supported Version Ranges
        bfd v6.0.0 -> 7.4.3
        [global] v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
      • cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int more...
        Supported Version Ranges
        cost v6.0.0 -> 7.4.3
      • dead_interval - Dead interval. type: int more...
        Supported Version Ranges
        dead_interval v6.0.0 -> 7.4.3
      • hello_interval - Hello interval. type: int more...
        Supported Version Ranges
        hello_interval v6.0.0 -> 7.4.3
      • interface - Configuration interface name. Source system.interface.name. type: str more...
        Supported Version Ranges
        interface v6.0.0 -> 7.4.3
      • ipsec_auth_alg - Authentication algorithm. type: str choices: md5, sha1, sha256, sha384, sha512 more...
        Supported Version Ranges
        ipsec_auth_alg v6.2.0 -> 7.4.3
        [md5] v6.2.0 -> 7.4.3
        [sha1] v6.2.0 -> 7.4.3
        [sha256] v6.2.0 -> 7.4.3
        [sha384] v6.2.0 -> 7.4.3
        [sha512] v6.2.0 -> 7.4.3
      • ipsec_enc_alg - Encryption algorithm. type: str choices: null, des, 3des, aes128, aes192, aes256 more...
        Supported Version Ranges
        ipsec_enc_alg v6.2.0 -> 7.4.3
        [null] v6.2.0 -> 7.4.3
        [des] v6.2.0 -> 7.4.3
        [3des] v6.2.0 -> 7.4.3
        [aes128] v6.2.0 -> 7.4.3
        [aes192] v6.2.0 -> 7.4.3
        [aes256] v6.2.0 -> 7.4.3
      • ipsec_keys - IPsec authentication and encryption keys. type: list member_path: ospf6_interface:name/ipsec_keys:spi more...
        Supported Version Ranges
        ipsec_keys v6.2.0 -> 7.4.3
        • auth_key - Authentication key. type: str more...
          Supported Version Ranges
          auth_key v6.2.0 -> 7.4.3
        • enc_key - Encryption key. type: str more...
          Supported Version Ranges
          enc_key v6.2.0 -> 7.4.3
        • spi - Security Parameters Index. see Notes. type: int required: true more...
          Supported Version Ranges
          spi v6.2.0 -> 7.4.3
      • key_rollover_interval - Key roll-over interval. type: int more...
        Supported Version Ranges
        key_rollover_interval v6.2.0 -> 7.4.3
      • mtu - MTU for OSPFv3 packets. type: int more...
        Supported Version Ranges
        mtu v6.0.0 -> 7.4.3
      • mtu_ignore - Enable/disable ignoring MTU field in DBD packets. type: str choices: enable, disable more...
        Supported Version Ranges
        mtu_ignore v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
      • name - Interface entry name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> 7.4.3
      • neighbor - OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media. type: list member_path: ospf6_interface:name/neighbor:ip6 more...
        Supported Version Ranges
        neighbor v6.0.0 -> 7.4.3
        • cost - Cost of the interface, value range from 0 to 65535, 0 means auto-cost. type: int more...
          Supported Version Ranges
          cost v6.0.0 -> 7.4.3
        • ip6 - IPv6 link local address of the neighbor. type: str required: true more...
          Supported Version Ranges
          ip6 v6.0.0 -> 7.4.3
        • poll_interval - Poll interval time in seconds. type: int more...
          Supported Version Ranges
          poll_interval v6.0.0 -> 7.4.3
        • priority - Priority. type: int more...
          Supported Version Ranges
          priority v6.0.0 -> 7.4.3
      • network_type - Network type. type: str choices: broadcast, point-to-point, non-broadcast, point-to-multipoint, point-to-multipoint-non-broadcast more...
        Supported Version Ranges
        network_type v6.0.0 -> 7.4.3
        [broadcast] v6.0.0 -> 7.4.3
        [point-to-point] v6.0.0 -> 7.4.3
        [non-broadcast] v6.0.0 -> 7.4.3
        [point-to-multipoint] v6.0.0 -> 7.4.3
        [point-to-multipoint-non-broadcast] v6.0.0 -> 7.4.3
      • priority - Priority. type: int more...
        Supported Version Ranges
        priority v6.0.0 -> 7.4.3
      • retransmit_interval - Retransmit interval. type: int more...
        Supported Version Ranges
        retransmit_interval v6.0.0 -> 7.4.3
      • status - Enable/disable OSPF6 routing on this interface. type: str choices: disable, enable more...
        Supported Version Ranges
        status v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
      • transmit_delay - Transmit delay. type: int more...
        Supported Version Ranges
        transmit_delay v6.0.0 -> 7.4.3
    • passive_interface - Passive interface configuration. type: list member_path: passive_interface:name more...
      Supported Version Ranges
      passive_interface v6.0.0 -> 7.4.3
      • name - Passive interface name. Source system.interface.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> 7.4.3
    • redistribute - Redistribute configuration. type: list member_path: redistribute:name more...
      Supported Version Ranges
      redistribute v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • metric - Redistribute metric setting. type: int more...
        Supported Version Ranges
        metric v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • metric_type - Metric type. type: str choices: 1, 2 more...
        Supported Version Ranges
        metric_type v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
        [1] v6.0.0 -> v7.0.5
        [2] v6.0.0 -> v7.0.5
      • name - Redistribute name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • routemap - Route map name. Source router.route-map.name. type: str more...
        Supported Version Ranges
        routemap v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • status - Status. type: str choices: enable, disable more...
        Supported Version Ranges
        status v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
        [enable] v6.0.0 -> v7.0.5
        [disable] v6.0.0 -> v7.0.5
    • restart_mode - OSPFv3 restart mode (graceful or none). type: str choices: none, graceful-restart more...
      Supported Version Ranges
      restart_mode v7.2.0 -> 7.4.3
      [none] v7.2.0 -> 7.4.3
      [graceful-restart] v7.2.0 -> 7.4.3
    • restart_on_topology_change - Enable/disable continuing graceful restart upon topology change. type: str choices: enable, disable more...
      Supported Version Ranges
      restart_on_topology_change v7.2.0 -> 7.4.3
      [enable] v7.2.0 -> 7.4.3
      [disable] v7.2.0 -> 7.4.3
    • restart_period - Graceful restart period in seconds. type: int more...
      Supported Version Ranges
      restart_period v7.2.0 -> 7.4.3
    • router_id - A.B.C.D, in IPv4 address format. type: str more...
      Supported Version Ranges
      router_id v6.0.0 -> 7.4.3
    • spf_timers - SPF calculation frequency. type: str more...
      Supported Version Ranges
      spf_timers v6.0.0 -> 7.4.3
    • summary_address - IPv6 address summary configuration. type: list member_path: summary_address:id more...
      Supported Version Ranges
      summary_address v6.0.0 -> 7.4.3
      • advertise - Enable/disable advertise status. type: str choices: disable, enable more...
        Supported Version Ranges
        advertise v6.0.0 -> 7.4.3
        [disable] v6.0.0 -> 7.4.3
        [enable] v6.0.0 -> 7.4.3
      • id - Summary address entry ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> 7.4.3
      • prefix6 - IPv6 prefix. type: str more...
        Supported Version Ranges
        prefix6 v6.0.0 -> 7.4.3
      • tag - Tag value. type: int more...
        Supported Version Ranges
        tag v6.0.0 -> 7.4.3

Notes

Note

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

Examples

- name: Configure IPv6 OSPF.
  fortinet.fortios.fortios_router_ospf6:
      vdom: "{{ vdom }}"
      router_ospf6:
          abr_type: "cisco"
          area:
              -
                  authentication: "none"
                  default_cost: "10"
                  id: "7"
                  ipsec_auth_alg: "md5"
                  ipsec_enc_alg: "null"
                  ipsec_keys:
                      -
                          auth_key: "<your_own_value>"
                          enc_key: "<your_own_value>"
                          spi: "<you_own_value>"
                  key_rollover_interval: "300"
                  nssa_default_information_originate: "enable"
                  nssa_default_information_originate_metric: "10"
                  nssa_default_information_originate_metric_type: "1"
                  nssa_redistribution: "enable"
                  nssa_translator_role: "candidate"
                  range:
                      -
                          advertise: "disable"
                          id: "22"
                          prefix6: "<your_own_value>"
                  stub_type: "no-summary"
                  type: "regular"
                  virtual_link:
                      -
                          authentication: "none"
                          dead_interval: "40"
                          hello_interval: "10"
                          ipsec_auth_alg: "md5"
                          ipsec_enc_alg: "null"
                          ipsec_keys:
                              -
                                  auth_key: "<your_own_value>"
                                  enc_key: "<your_own_value>"
                                  spi: "<you_own_value>"
                          key_rollover_interval: "300"
                          name: "default_name_37"
                          peer: "<your_own_value>"
                          retransmit_interval: "5"
                          transmit_delay: "1"
          auto_cost_ref_bandwidth: "1000"
          bfd: "enable"
          default_information_metric: "10"
          default_information_metric_type: "1"
          default_information_originate: "enable"
          default_information_route_map: "<your_own_value> (source router.route-map.name)"
          default_metric: "10"
          log_neighbour_changes: "enable"
          ospf6_interface:
              -
                  area_id: "<your_own_value>"
                  authentication: "none"
                  bfd: "global"
                  cost: "0"
                  dead_interval: "0"
                  hello_interval: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  ipsec_auth_alg: "md5"
                  ipsec_enc_alg: "null"
                  ipsec_keys:
                      -
                          auth_key: "<your_own_value>"
                          enc_key: "<your_own_value>"
                          spi: "<you_own_value>"
                  key_rollover_interval: "300"
                  mtu: "0"
                  mtu_ignore: "enable"
                  name: "default_name_66"
                  neighbor:
                      -
                          cost: "0"
                          ip6: "<your_own_value>"
                          poll_interval: "10"
                          priority: "1"
                  network_type: "broadcast"
                  priority: "1"
                  retransmit_interval: "5"
                  status: "disable"
                  transmit_delay: "1"
          passive_interface:
              -
                  name: "default_name_78 (source system.interface.name)"
          redistribute:
              -
                  metric: "0"
                  metric_type: "1"
                  name: "default_name_82"
                  routemap: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
          restart_mode: "none"
          restart_on_topology_change: "enable"
          restart_period: "120"
          router_id: "<your_own_value>"
          spf_timers: "<your_own_value>"
          summary_address:
              -
                  advertise: "disable"
                  id: "92"
                  prefix6: "<your_own_value>"
                  tag: "0"

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.