:source: fmgd_system_sdnconnector.py :orphan: .. _fmgd_system_sdnconnector: fmgd_system_sdnconnector -- Configure connection to SDN Connector. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure connection to SDN Connector. fortinet.fmgdevice.fmgd_system_sdnconnector: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: state: present # system_sdnconnector: name: "your value" # Required variable, string # _local_cert: # access_key: # alt_resource_ip: # api_key: # azure_region: # client_id: # client_secret: # compartment_id: # compute_generation: # domain: # external_account_list: # - external_id: # region_list: # role_arn: # external_ip: # - name: # forwarding_rule: # - rule_name: # target: # gcp_project_list: # - gcp_zone_list: # id: # group_name: # ha_status: # ibm_region: # key_passwd: # login_endpoint: # nic: # - ip: # - name: # public_ip: # resource_group: # private_ip: # name: # peer_nic: # oci_cert: # oci_fingerprint: # oci_region: # oci_region_type: # password: # private_key: # region: # resource_group: # resource_url: # route: # - name: # route_table: # - name: # resource_group: # route: # - name: # next_hop: # subscription_id: # secret_key: # secret_token: # server: # server_ca_cert: # server_cert: # server_list: # server_port: # service_account: # status: # subscription_id: # tenant_id: # type: # update_interval: # use_metadata_iam: # user_id: # username: # vcenter_password: # vcenter_server: # vcenter_username: # verify_certificate: # vpc_id: # proxy: # compartment_list: # - compartment_id: # oci_region_list: # - region: # rest_ssl: # vmx_image_url: # rest_interface: # rest_sport: # nsx_cert_fingerprint: # vmx_service_name: # rest_password: # gcp_project: # ibm_region_gen2: # ibm_region_gen1: # server_ip: # microsoft_365: # vdom: # message_server_port: # par_id: Return Values ------------- Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)