fortios_system_sdn_connector – Configure connection to SDN Connector in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.4.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - 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. type: str required: False choices: present, absent
- system_sdn_connector - Configure connection to SDN Connector. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- access_key - AWS / ACS access key ID. type: str
- azure_region - Azure server region. type: str choices: global, china, germany, usgov, local
- client_id - Azure client ID (application ID). type: str
- client_secret - Azure client secret (application key). type: str
- compartment_id - Compartment ID. type: str
- domain - Domain name. type: str
- external_ip - Configure GCP external IP. type: list
- name - External IP name. type: str required: True
- gcp_project - GCP project name. type: str
- group_name - Group name of computers. type: str
- ha_status - Enable/disable use for FortiGate HA service. type: str choices: disable, enable
- login_endpoint - Azure Stack login endpoint. type: str
- name - SDN connector name. type: str required: True
- nic - Configure Azure network interface. type: list
- ip - Configure IP configuration. type: list
- name - IP configuration name. type: str required: True
- public_ip - Public IP name. type: str
- resource_group - Resource group of Azure public IP. type: str
- name - Network interface name. type: str required: True
- oci_cert - OCI certificate. Source certificate.local.name. type: str
- oci_fingerprint - OCI pubkey fingerprint. type: str
- oci_region - OCI server region. type: str
- oci_region_type - OCI region type. type: str choices: commercial, government
- password - Password of the remote SDN connector as login credentials. type: password_aes256
- private_key - Private key of GCP service account. type: str
- region - AWS / ACS region name. type: str
- resource_group - Azure resource group. type: str
- resource_url - Azure Stack resource URL. type: str
- route - Configure GCP route. type: list
- name - Route name. type: str required: True
- route_table - Configure Azure route table. type: list
- name - Route table name. type: str required: True
- resource_group - Resource group of Azure route table. type: str
- route - Configure Azure route. type: list
- name - Route name. type: str required: True
- next_hop - Next hop address. type: str
- secret_key - AWS / ACS secret access key. type: str
- secret_token - Secret token of Kubernetes service account. type: str
- server - Server address of the remote SDN connector. type: str
- server_port - Port number of the remote SDN connector. type: int
- service_account - GCP service account email. type: str
- status - Enable/disable connection to the remote SDN connector. type: str choices: disable, enable
- subscription_id - Azure subscription ID. type: str
- tenant_id - Tenant ID (directory ID). type: str
- type - Type of SDN connector. type: str choices: aci, alicloud, aws, azure, gcp, nsx, nuage, oci, openstack, kubernetes, vmware, sepm, aci-direct
- update_interval - Dynamic object update interval (30 - 3600 sec). type: int
- use_metadata_iam - Enable/disable use of IAM role from metadata to call API. type: str choices: disable, enable
- user_id - User ID. type: str
- username - Username of the remote SDN connector as login credentials. type: str
- vpc_id - AWS VPC ID. type: str
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>"
compartment_id: "<your_own_value>"
domain: "<your_own_value>"
external_ip:
-
name: "default_name_10"
gcp_project: "<your_own_value>"
group_name: "<your_own_value>"
ha_status: "disable"
login_endpoint: "<your_own_value>"
name: "default_name_15"
nic:
-
ip:
-
name: "default_name_18"
public_ip: "<your_own_value>"
resource_group: "<your_own_value>"
name: "default_name_21"
oci_cert: "<your_own_value> (source certificate.local.name)"
oci_fingerprint: "<your_own_value>"
oci_region: "<your_own_value>"
oci_region_type: "commercial"
password: "<your_own_value>"
private_key: "<your_own_value>"
region: "<your_own_value>"
resource_group: "<your_own_value>"
resource_url: "<your_own_value>"
route:
-
name: "default_name_32"
route_table:
-
name: "default_name_34"
resource_group: "<your_own_value>"
route:
-
name: "default_name_37"
next_hop: "<your_own_value>"
secret_key: "<your_own_value>"
secret_token: "<your_own_value>"
server: "192.168.100.40"
server_port: "42"
service_account: "<your_own_value>"
status: "disable"
subscription_id: "<your_own_value>"
tenant_id: "<your_own_value>"
type: "aci"
update_interval: "48"
use_metadata_iam: "disable"
user_id: "<your_own_value>"
username: "<your_own_value>"
vpc_id: "<your_own_value>"
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:
- 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