:source: fortios_system_sdn_connector.py :orphan: .. fortios_system_sdn_connector: fortios_system_sdn_connector -- Configure connection to SDN Connector in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sdn_connector category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0 Requirements ------------ The below requirements are needed on the host that executes this module. - ansible>=2.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure connection to SDN Connector. fortinet.fortios.fortios_system_sdn_connector: vdom: "{{ vdom }}" state: "present" access_token: "" system_sdn_connector: access_key: "" alt_resource_ip: "disable" api_key: "" azure_region: "global" client_id: "" client_secret: "" compartment_id: "" compartment_list: - compartment_id: "" compute_generation: "2" domain: "" external_account_list: - external_id: "" region_list: - region: "" role_arn: "" external_ip: - name: "default_name_20" forwarding_rule: - rule_name: "" target: "" gcp_project: "" gcp_project_list: - gcp_zone_list: - name: "default_name_27" id: "28" group_name: "" ha_status: "disable" ibm_region: "dallas" ibm_region_gen1: "us-south" ibm_region_gen2: "us-south" key_passwd: "" login_endpoint: "" message_server_port: "0" microsoft_365: "disable" name: "default_name_38" nic: - ip: - name: "default_name_41" private_ip: "" public_ip: "" resource_group: "" name: "default_name_45" peer_nic: "" oci_cert: " (source certificate.local.name)" oci_fingerprint: "" oci_region: "phoenix" oci_region_list: - region: "" oci_region_type: "commercial" par_id: "" password: "" private_key: "" proxy: " (source system.sdn-proxy.name)" region: "" resource_group: "" resource_url: "" route: - name: "default_name_61" route_table: - name: "default_name_63" resource_group: "" route: - name: "default_name_66" next_hop: "" subscription_id: "" secret_key: "" secret_token: "" server: "192.168.100.40" server_ca_cert: " (source certificate.remote.name certificate.ca.name)" server_cert: " (source certificate.remote.name)" server_list: - ip: "" server_port: "0" service_account: "" status: "disable" subscription_id: "" tenant_id: "" type: "aci" update_interval: "60" use_metadata_iam: "disable" user_id: "" username: "" vcenter_password: "" vcenter_server: "" vcenter_username: "" vdom: " (source system.vdom.name)" verify_certificate: "disable" vpc_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
  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.