fortinet.fortimanager.fmgr_firewall_proxyaddress (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_proxyaddress:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_proxyaddress:
          case-sensitivity: disable
          color: 1
          comment: "ansible-comment"
          name: "ansible-test"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the proxy addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_proxyaddress"
          params:
            adom: "ansible"
            proxy-address: "your_value"

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
    type: list

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

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    type: bool

firewall_proxyaddress:
    description: The top level parameters set.
    required: false
    suboptions:
      _image-base64:
        description: Deprecated, please rename it to _image_base64. _Image-Base64.
        type: str
      application:
        description: (list) No description.
        type: raw
      case-sensitivity:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to case_sensitivity. Enable to make
          the pattern case sensitive.
        type: str
      category:
        description: (list or str) FortiGuard category ID.
        type: raw
      color:
        description: Integer value to determine the color of the icon in the GUI
        type: int
      comment:
        description: Optional comments.
        type: str
      header:
        description: HTTP header name as a regular expression.
        type: str
      header-group:
        description: Deprecated, please rename it to header_group. Header-Group.
        elements: dict
        suboptions:
          case-sensitivity:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to case_sensitivity. Case sensitivity
              in pattern.
            type: str
          header:
            description: HTTP header regular expression.
            type: str
          header-name:
            description: Deprecated, please rename it to header_name. HTTP header.
            type: str
          id:
            description: ID.
            type: int
        type: list
      header-name:
        description: Deprecated, please rename it to header_name. Name of HTTP header.
        type: str
      host:
        description: Address object for the host.
        type: str
      host-regex:
        description: Deprecated, please rename it to host_regex. Host name as a regular
          expression.
        type: str
      method:
        choices:
        - delete
        - get
        - head
        - options
        - post
        - put
        - trace
        - connect
        description: HTTP request methods to be used.
        elements: str
        type: list
      name:
        description: Address name.
        required: true
        type: str
      path:
        description: URL path as a regular expression.
        type: str
      query:
        description: Match the query part of the URL as a regular expression.
        type: str
      referrer:
        choices:
        - disable
        - enable
        description: Enable/disable use of referrer field in the HTTP header to match
          the address.
        type: str
      tagging:
        description: Tagging.
        elements: dict
        suboptions:
          category:
            description: Tag category.
            type: str
          name:
            description: Tagging entry name.
            type: str
          tags:
            description: (list) Tags.
            type: raw
        type: list
      tags:
        description: Names of object-tags
        type: str
      type:
        choices:
        - host-regex
        - url
        - category
        - method
        - ua
        - header
        - src-advanced
        - dst-advanced
        - url-list
        - saas
        description: Proxy address type.
        type: str
      ua:
        choices:
        - chrome
        - ms
        - firefox
        - safari
        - other
        - ie
        - edge
        description: Names of browsers to be used as user agent.
        elements: str
        type: list
      ua-max-ver:
        description: Deprecated, please rename it to ua_max_ver. Maximum version of the
          user agent specified in dotted notation.
        type: str
      ua-min-ver:
        description: Deprecated, please rename it to ua_min_ver. Minimum version of the
          user agent specified in dotted notation.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: Enable/disable visibility of the object in the GUI.
        type: str
    type: dict

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

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

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

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