drmofu.fortimanager.fmgr_dynamic_virtualwanlink_members (2.2.2) — module

FortiGate interfaces added to the virtual-wan-link.

| "added in version" 2.0.0 of drmofu.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: FortiGate interfaces added to the virtual-wan-link.
      fmgr_dynamic_virtualwanlink_members:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         adom: <your own value>
         state: <value in [present, absent]>
         dynamic_virtualwanlink_members:
            comment: <value of string>
            cost: <value of integer>
            detect-failtime: <value of integer>
            detect-http-get: <value of string>
            detect-http-match: <value of string>
            detect-http-port: <value of integer>
            detect-interval: <value of integer>
            detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]>
            detect-recoverytime: <value of integer>
            detect-server: <value of string>
            detect-timeout: <value of integer>
            dynamic_mapping:
              -
                  _scope:
                    -
                        name: <value of string>
                        vdom: <value of string>
                  comment: <value of string>
                  cost: <value of integer>
                  detect-failtime: <value of integer>
                  detect-http-get: <value of string>
                  detect-http-match: <value of string>
                  detect-http-port: <value of integer>
                  detect-interval: <value of integer>
                  detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]>
                  detect-recoverytime: <value of integer>
                  detect-server: <value of string>
                  detect-timeout: <value of integer>
                  gateway: <value of string>
                  gateway6: <value of string>
                  ingress-spillover-threshold: <value of integer>
                  interface: <value of string>
                  priority: <value of integer>
                  source: <value of string>
                  source6: <value of string>
                  spillover-threshold: <value of integer>
                  status: <value in [disable, enable]>
                  volume-ratio: <value of integer>
                  weight: <value of integer>
            gateway: <value of string>
            gateway6: <value of string>
            ingress-spillover-threshold: <value of integer>
            interface: <value of string>
            name: <value of string>
            priority: <value of integer>
            source: <value of string>
            source6: <value of string>
            spillover-threshold: <value of integer>
            status: <value in [disable, enable]>
            volume-ratio: <value of integer>
            weight: <value of integer>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

dynamic_virtualwanlink_members:
    description: the top level parameters set
    required: false
    suboptions:
      comment:
        description: no description
        type: str
      cost:
        description: no description
        type: int
      detect-failtime:
        description: no description
        type: int
      detect-http-get:
        description: no description
        type: str
      detect-http-match:
        description: no description
        type: str
      detect-http-port:
        description: no description
        type: int
      detect-interval:
        description: no description
        type: int
      detect-protocol:
        choices:
        - ping
        - tcp-echo
        - udp-echo
        - http
        description: no description
        type: str
      detect-recoverytime:
        description: no description
        type: int
      detect-server:
        description: no description
        type: str
      detect-timeout:
        description: no description
        type: int
      dynamic_mapping:
        description: description
        elements: dict
        suboptions:
          _scope:
            description: description
            elements: dict
            suboptions:
              name:
                description: no description
                type: str
              vdom:
                description: no description
                type: str
            type: list
          comment:
            description: no description
            type: str
          cost:
            description: no description
            type: int
          detect-failtime:
            description: no description
            type: int
          detect-http-get:
            description: no description
            type: str
          detect-http-match:
            description: no description
            type: str
          detect-http-port:
            description: no description
            type: int
          detect-interval:
            description: no description
            type: int
          detect-protocol:
            choices:
            - ping
            - tcp-echo
            - udp-echo
            - http
            description: no description
            type: str
          detect-recoverytime:
            description: no description
            type: int
          detect-server:
            description: no description
            type: str
          detect-timeout:
            description: no description
            type: int
          gateway:
            description: no description
            type: str
          gateway6:
            description: no description
            type: str
          ingress-spillover-threshold:
            description: no description
            type: int
          interface:
            description: no description
            type: str
          priority:
            description: no description
            type: int
          source:
            description: no description
            type: str
          source6:
            description: no description
            type: str
          spillover-threshold:
            description: no description
            type: int
          status:
            choices:
            - disable
            - enable
            description: no description
            type: str
          volume-ratio:
            description: no description
            type: int
          weight:
            description: no description
            type: int
        type: list
      gateway:
        description: no description
        type: str
      gateway6:
        description: no description
        type: str
      ingress-spillover-threshold:
        description: no description
        type: int
      interface:
        description: no description
        type: str
      name:
        description: no description
        type: str
      priority:
        description: no description
        type: int
      source:
        description: no description
        type: str
      source6:
        description: no description
        type: str
      spillover-threshold:
        description: no description
        type: int
      status:
        choices:
        - disable
        - enable
        description: no description
        type: str
      volume-ratio:
        description: no description
        type: int
      weight:
        description: no description
        type: int
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list