drmofu.fortimanager.fmgr_system_ha (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: HA configuration.
      fmgr_system_ha:
         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, ...]
         system_ha:
            clusterid: <value of integer>
            file-quota: <value of integer>
            hb-interval: <value of integer>
            hb-lost-threshold: <value of integer>
            mode: <value in [standalone, master, slave, ...]>
            password: <value of string>
            peer:
              -
                  id: <value of integer>
                  ip: <value of string>
                  ip6: <value of string>
                  serial-number: <value of string>
                  status: <value in [disable, enable]>
            local-cert: <value of string>
            failover-mode: <value in [manual, vrrp]>
            monitored-interfaces:
              -
                  interface-name: <value of string>
            monitored-ips:
              -
                  id: <value of integer>
                  interface: <value of string>
                  ip: <value of string>
            priority: <value of integer>
            unicast: <value in [disable, enable]>
            vip: <value of string>
            vrrp-adv-interval: <value of integer>
            vrrp-interface: <value of string>

Inputs

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

system_ha:
    description: the top level parameters set
    required: false
    suboptions:
      clusterid:
        description: Cluster ID range
        type: int
      failover-mode:
        choices:
        - manual
        - vrrp
        description:
        - HA failover mode.
        - manual - Manual Failove
        - vrrp - Use VRRP
        type: str
      file-quota:
        description: File quota in MB
        type: int
      hb-interval:
        description: Heartbeat interval
        type: int
      hb-lost-threshold:
        description: Heartbeat lost threshold
        type: int
      local-cert:
        description: set the ha local certificate.
        type: str
      mode:
        choices:
        - standalone
        - master
        - slave
        - primary
        - secondary
        description:
        - Mode.
        - standalone - Standalone.
        - master - Master.
        - slave - Slave.
        type: str
      monitored-interfaces:
        description: description
        elements: dict
        suboptions:
          interface-name:
            description: Interface name.
            type: str
        type: list
      monitored-ips:
        description: description
        elements: dict
        suboptions:
          id:
            description: Id.
            type: int
          interface:
            description: Interface name.
            type: str
          ip:
            description: IP address.
            type: str
        type: list
      password:
        description: Group password.
        type: str
      peer:
        description: Peer.
        elements: dict
        suboptions:
          id:
            description: Id.
            type: int
          ip:
            description: IP address of peer.
            type: str
          ip6:
            description: IP address
            type: str
          serial-number:
            description: Serial number of peer.
            type: str
          status:
            choices:
            - disable
            - enable
            description:
            - Peer admin status.
            - disable - Disable.
            - enable - Enable.
            type: str
        type: list
      priority:
        description: Runtime priority [1
        type: int
      unicast:
        choices:
        - disable
        - enable
        description:
        - Use unitcast for VRRP message.
        - disable - Disable.
        - enable - Enable.
        type: str
      vip:
        description: Virtual IP.
        type: str
      vrrp-adv-interval:
        description: VRRP advert interval [1 - 30 seconnds]
        type: int
      vrrp-interface:
        description: VRRP and vip interface.
        type: str
    type: dict

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

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