fortinet.fortios.fortios_system_sdn_connector – Configure connection to SDN Connector in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 1.1.8).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_sdn_connector.

New in version 2.8: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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.9.0

Parameters

Parameter				Choices/Defaults	Comments
access_token string					Token-based authentication. Generated from GUI of Fortigate.
state string added in 2.9 of fortinet.fortios				present absent	Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
system_sdn_connector dictionary					Configure connection to SDN Connector.
	access_key string				AWS access key ID.
	azure_region string			global china	Azure Region (Global/China).
	client_id string				Azure client ID (application ID).
	client_secret string				Azure client secret (application key).
	external_ip list / elements=string				Configure GCP external IP.
		name string / required			External IP name.
	name string / required				SDN connector name.
	nic list / elements=string				Configure Azure network interface.
		ip list / elements=string			Configure IP configuration.
			name string / required		IP configuration name.
			public_ip string		Public IP name.
		name string / required			Network interface name.
	password string				Password of the remote SDN connector as login credentials.
	region string				AWS region name.
	resource_group string				Azure resource group.
	route list / elements=string				Configure GCP route.
		name string / required			Route name.
	route_table list / elements=string				Configure Azure route table.
		name string / required			Route table name.
		route list / elements=string			Configure Azure route.
			name string / required		Route name.
			next_hop string		Next hop address.
	secret_key string				AWS secret access key.
	server string				Server address of the remote SDN connector.
	server_port integer				Port number of the remote SDN connector.
	state string			present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	status string			disable enable	Enable/disable connection to the remote SDN connector.
	subscription_id string				Azure subscription ID.
	tenant_id string				Azure tenant ID (directory ID).
	type string			aci aws azure nsx nuage gcp	Type of SDN connector.
	update_interval integer				Dynamic object update interval (0 - 3600 sec, 0 means disabled).
	username string				Username of the remote SDN connector as login credentials.
	vpc_id string				AWS VPC ID.
vdom string				Default: "root"	Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure connection to SDN Connector.
    fortios_system_sdn_connector:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sdn_connector:
        access_key: "<your_own_value>"
        azure_region: "global"
        client_id: "<your_own_value>"
        client_secret: "<your_own_value>"
        external_ip:
         -
            name: "default_name_8"
        name: "default_name_9"
        nic:
         -
            ip:
             -
                name: "default_name_12"
                public_ip: "<your_own_value>"
            name: "default_name_14"
        password: "<your_own_value>"
        region: "<your_own_value>"
        resource_group: "<your_own_value>"
        route:
         -
            name: "default_name_19"
        route_table:
         -
            name: "default_name_21"
            route:
             -
                name: "default_name_23"
                next_hop: "<your_own_value>"
        secret_key: "<your_own_value>"
        server: "192.168.100.40"
        server_port: "27"
        status: "disable"
        subscription_id: "<your_own_value>"
        tenant_id: "<your_own_value>"
        type: "aci"
        update_interval: "32"
        username: "<your_own_value>"
        vpc_id: "<your_own_value>"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_sdn_connector_module.html