drmofu.fortimanager.fmgr_firewall_accessproxy_apigateway_realservers (2.2.2) — module

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

Scanned by Steampunk Spotter

• 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: Select the real servers that this Access Proxy will distribute traffic to.
      fmgr_firewall_accessproxy_apigateway_realservers:
         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>
         access-proxy: <your own value>
         api-gateway: <your own value>
         state: <value in [present, absent]>
         firewall_accessproxy_apigateway_realservers:
            address: <value of string>
            health-check: <value in [disable, enable]>
            health-check-proto: <value in [ping, http, tcp-connect]>
            http-host: <value of string>
            id: <value of integer>
            ip: <value of string>
            mappedport: <value of string>
            port: <value of integer>
            status: <value in [active, standby, disable]>
            weight: <value of integer>
            addr-type: <value in [fqdn, ip]>
            domain: <value of string>
            holddown-interval: <value in [disable, enable]>
            ssh-client-cert: <value of string>
            ssh-host-key: <value of string>
            ssh-host-key-validation: <value in [disable, enable]>
            type: <value in [tcp-forwarding, ssh]>
            translate-host: <value in [disable, enable]>
            external-auth: <value in [disable, enable]>
            tunnel-encryption: <value in [disable, enable]>

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

api-gateway:
    description: the parameter (api-gateway) in requested url
    required: true
    type: str

access-proxy:
    description: the parameter (access-proxy) in requested url
    required: true
    type: str

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

firewall_accessproxy_apigateway_realservers:
    description: the top level parameters set
    required: false
    suboptions:
      addr-type:
        choices:
        - fqdn
        - ip
        description: Type of address.
        type: str
      address:
        description: Address or address group of the real server.
        type: str
      domain:
        description: Wildcard domain name of the real server.
        type: str
      external-auth:
        choices:
        - disable
        - enable
        description: Enable/disable use of external browser as user-agent for SAML user
          authentication.
        type: str
      health-check:
        choices:
        - disable
        - enable
        description: Enable to check the responsiveness of the real server before forwarding
          traffic.
        type: str
      health-check-proto:
        choices:
        - ping
        - http
        - tcp-connect
        description: Protocol of the health check monitor to use when polling to determine
          servers connectivity status.
        type: str
      holddown-interval:
        choices:
        - disable
        - enable
        description: Enable/disable holddown timer.
        type: str
      http-host:
        description: HTTP server domain name in HTTP header.
        type: str
      id:
        description: Real server ID.
        type: int
      ip:
        description: IP address of the real server.
        type: str
      mappedport:
        description: Port for communicating with the real server.
        type: str
      port:
        description: Port for communicating with the real server.
        type: int
      ssh-client-cert:
        description: Set access-proxy SSH client certificate profile.
        type: str
      ssh-host-key:
        description: description
        type: str
      ssh-host-key-validation:
        choices:
        - disable
        - enable
        description: Enable/disable SSH real server host key validation.
        type: str
      status:
        choices:
        - active
        - standby
        - disable
        description: Set the status of the real server to active so that it can accept
          traffic, or on standby or disabled so no traffic is sent.
        type: str
      translate-host:
        choices:
        - disable
        - enable
        description: Enable/disable translation of hostname/IP from virtual server to
          real server.
        type: str
      tunnel-encryption:
        choices:
        - disable
        - enable
        description: Tunnel encryption.
        type: str
      type:
        choices:
        - tcp-forwarding
        - ssh
        description: TCP forwarding server type.
        type: str
      weight:
        description: Weight of the real server.
        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