drmofu.fortimanager.fmgr_devprof_system_centralmanagement (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: Configure central management.
      fmgr_devprof_system_centralmanagement:
         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>
         devprof: <your own value>
         devprof_system_centralmanagement:
            include-default-servers: <value in [disable, enable]>
            server-list:
              -
                  addr-type: <value in [fqdn, ipv4, ipv6]>
                  fqdn: <value of string>
                  id: <value of integer>
                  server-address: <value of string>
                  server-address6: <value of string>
                  server-type:
                    - update
                    - rating
                    - iot-query
                    - iot-collect

Inputs

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

devprof:
    description: the parameter (devprof) in requested url
    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

devprof_system_centralmanagement:
    description: the top level parameters set
    required: false
    suboptions:
      include-default-servers:
        choices:
        - disable
        - enable
        description: Enable/disable inclusion of public FortiGuard servers in the override
          server list.
        type: str
      server-list:
        description: description
        elements: dict
        suboptions:
          addr-type:
            choices:
            - fqdn
            - ipv4
            - ipv6
            description: Indicate whether the FortiGate communicates with the override
              server using an IPv4 address, an IPv6 address or a FQDN.
            type: str
          fqdn:
            description: FQDN address of override server.
            type: str
          id:
            description: ID.
            type: int
          server-address:
            description: IPv4 address of override server.
            type: str
          server-address6:
            description: IPv6 address of override server.
            type: str
          server-type:
            choices:
            - update
            - rating
            - iot-query
            - iot-collect
            description: description
            elements: str
            type: list
        type: list
    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