: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
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_sdn_connector - Configure connection to SDN Connector. type: dict
more...
| Supported Version Ranges |
| system_sdn_connector |
v6.0.0 -> 7.6.6 |
- access_key - AWS / ACS access key ID. type: str
more...
|
Supported Version Ranges |
| access_key |
v6.0.0 -> 7.6.6 |
- alt_resource_ip - Enable/disable AWS alternative resource IP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| alt_resource_ip |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
- api_key - IBM cloud API key or service ID API key. type: str
more...
|
Supported Version Ranges |
| api_key |
v6.4.0 -> 7.6.6 |
- azure_region - Azure server region. type: str choices: global, china, germany, usgov, local
more...
|
Supported Version Ranges |
| azure_region |
v6.0.0 -> 7.6.6 |
| [global] |
v6.0.0 -> 7.6.6 |
| [china] |
v6.0.0 -> 7.6.6 |
| [germany] |
v6.0.0 -> 7.6.6 |
| [usgov] |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
- client_id - Azure client ID (application ID). type: str
more...
|
Supported Version Ranges |
| client_id |
v6.0.0 -> 7.6.6 |
- client_secret - Azure client secret (application key). type: str
more...
|
Supported Version Ranges |
| client_secret |
v6.0.0 -> 7.6.6 |
- compartment_id - Compartment ID. type: str
more...
|
Supported Version Ranges |
| compartment_id |
v6.0.0 -> v7.2.4 |
- compartment_list - Configure OCI compartment list. type: list member_path: compartment_list:compartment_id
more...
| Supported Version Ranges |
| compartment_list |
v7.4.0 -> 7.6.6 |
- compartment_id - OCI compartment ID. type: str required: true
more...
|
Supported Version Ranges |
| compartment_id |
v7.4.0 -> 7.6.6 |
- compute_generation - Compute generation for IBM cloud infrastructure. type: int
more...
|
Supported Version Ranges |
| compute_generation |
v6.4.0 -> v7.6.0 |
- domain - Domain name. type: str
more...
|
Supported Version Ranges |
| domain |
v6.2.0 -> 7.6.6 |
- external_account_list - Configure AWS external account list. type: list member_path: external_account_list:role_arn
more...
| Supported Version Ranges |
| external_account_list |
v7.0.4 -> 7.6.6 |
- external_id - AWS external ID. type: str
more...
|
Supported Version Ranges |
| external_id |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
- region_list - AWS region name list. type: list member_path: external_account_list:role_arn/region_list:region
more...
| Supported Version Ranges |
| region_list |
v7.0.4 -> 7.6.6 |
- region - AWS region name. type: str required: true
more...
|
Supported Version Ranges |
| region |
v7.0.4 -> 7.6.6 |
- role_arn - AWS role ARN to assume. type: str required: true
more...
|
Supported Version Ranges |
| role_arn |
v7.0.4 -> 7.6.6 |
- external_ip - Configure GCP external IP. type: list member_path: external_ip:name
more...
| Supported Version Ranges |
| external_ip |
v6.0.0 -> 7.6.6 |
- name - External IP name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- forwarding_rule - Configure GCP forwarding rule. type: list member_path: forwarding_rule:rule_name
more...
| Supported Version Ranges |
| forwarding_rule |
v7.0.2 -> 7.6.6 |
- rule_name - Forwarding rule name. type: str required: true
more...
|
Supported Version Ranges |
| rule_name |
v7.0.2 -> 7.6.6 |
- target - Target instance name. type: str
more...
|
Supported Version Ranges |
| target |
v7.0.2 -> 7.6.6 |
- gcp_project - GCP project name. type: str
more...
|
Supported Version Ranges |
| gcp_project |
v6.0.0 -> v7.0.3 |
- gcp_project_list - Configure GCP project list. type: list member_path: gcp_project_list:id
more...
| Supported Version Ranges |
| gcp_project_list |
v7.0.4 -> 7.6.6 |
- gcp_zone_list - Configure GCP zone list. type: list member_path: gcp_project_list:id/gcp_zone_list:name
more...
| Supported Version Ranges |
| gcp_zone_list |
v7.0.4 -> 7.6.6 |
- name - GCP zone name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.0.4 -> 7.6.6 |
- id - GCP project ID. type: str required: true
more...
|
Supported Version Ranges |
| id |
v7.0.4 -> 7.6.6 |
- group_name - Full path group name of computers. type: str
more...
|
Supported Version Ranges |
| group_name |
v6.2.0 -> 7.6.6 |
- ha_status - Enable/disable use for FortiGate HA service. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ha_status |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
- ibm_region - IBM cloud region name. type: str choices: dallas, washington-dc, london, frankfurt, sydney, tokyo, osaka, toronto, sao-paulo, madrid, us-south, us-east, germany, great-britain, japan, australia
more...
|
Supported Version Ranges |
| ibm_region |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [dallas] |
v7.0.4 -> 7.6.6 |
| [washington-dc] |
v7.0.4 -> 7.6.6 |
| [london] |
v7.0.4 -> 7.6.6 |
| [frankfurt] |
v7.0.4 -> 7.6.6 |
| [sydney] |
v7.0.4 -> 7.6.6 |
| [tokyo] |
v7.0.4 -> 7.6.6 |
| [osaka] |
v7.0.4 -> 7.6.6 |
| [toronto] |
v7.0.4 -> 7.6.6 |
| [sao-paulo] |
v7.0.4 -> 7.6.6 |
| [madrid] |
v7.6.1 -> 7.6.6 |
| [us-south] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
| [us-east] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
| [germany] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
| [great-britain] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
| [japan] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
| [australia] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> v7.0.3 |
- ibm_region_gen1 - IBM cloud compute generation 1 region name. type: str choices: us-south, us-east, germany, great-britain, japan, australia
more...
|
Supported Version Ranges |
| ibm_region_gen1 |
v6.4.1 -> v6.4.1 |
| [us-south] |
v6.4.1 -> v6.4.1 |
| [us-east] |
v6.4.1 -> v6.4.1 |
| [germany] |
v6.4.1 -> v6.4.1 |
| [great-britain] |
v6.4.1 -> v6.4.1 |
| [japan] |
v6.4.1 -> v6.4.1 |
| [australia] |
v6.4.1 -> v6.4.1 |
- ibm_region_gen2 - IBM cloud compute generation 2 region name. type: str choices: us-south, us-east, great-britain
more...
|
Supported Version Ranges |
| ibm_region_gen2 |
v6.4.1 -> v6.4.1 |
| [us-south] |
v6.4.1 -> v6.4.1 |
| [us-east] |
v6.4.1 -> v6.4.1 |
| [great-britain] |
v6.4.1 -> v6.4.1 |
- key_passwd - Private key password. type: str
more...
|
Supported Version Ranges |
| key_passwd |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- login_endpoint - Azure Stack login endpoint. type: str
more...
|
Supported Version Ranges |
| login_endpoint |
v6.0.0 -> 7.6.6 |
- message_server_port - HTTP port number of the SAP message server. type: int
more...
|
Supported Version Ranges |
| message_server_port |
v7.6.1 -> 7.6.6 |
- microsoft_365 - Enable to use as Microsoft 365 connector. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| microsoft_365 |
v7.6.3 -> 7.6.6 |
| [disable] |
v7.6.3 -> 7.6.6 |
| [enable] |
v7.6.3 -> 7.6.6 |
- name - SDN connector name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- nic - Configure Azure network interface. type: list member_path: nic:name
more...
| Supported Version Ranges |
| nic |
v6.0.0 -> 7.6.6 |
- ip - Configure IP configuration. type: list member_path: nic:name/ip:name
more...
| Supported Version Ranges |
| ip |
v6.0.0 -> 7.6.6 |
- name - IP configuration name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- private_ip - Private IP address. type: str
more...
|
Supported Version Ranges |
| private_ip |
v7.6.1 -> 7.6.6 |
- public_ip - Public IP name. type: str
more...
|
Supported Version Ranges |
| public_ip |
v6.0.0 -> 7.6.6 |
- resource_group - Resource group of Azure public IP. type: str
more...
|
Supported Version Ranges |
| resource_group |
v6.2.0 -> 7.6.6 |
- name - Network interface name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- peer_nic - Peer network interface name. type: str
more...
|
Supported Version Ranges |
| peer_nic |
v7.6.1 -> 7.6.6 |
- oci_cert - OCI certificate. Source certificate.local.name. type: str
more...
|
Supported Version Ranges |
| oci_cert |
v6.0.0 -> 7.6.6 |
- oci_fingerprint - OCI pubkey fingerprint. type: str
more...
|
Supported Version Ranges |
| oci_fingerprint |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- oci_region - OCI server region. type: str choices: phoenix, ashburn, frankfurt, london
more...
|
Supported Version Ranges |
| oci_region |
v6.0.0 -> v7.2.4 |
| [phoenix] |
v6.0.0 -> v6.0.11 |
| [ashburn] |
v6.0.0 -> v6.0.11 |
| [frankfurt] |
v6.0.0 -> v6.0.11 |
| [london] |
v6.0.0 -> v6.0.11 |
- oci_region_list - Configure OCI region list. type: list member_path: oci_region_list:region
more...
| Supported Version Ranges |
| oci_region_list |
v7.4.0 -> 7.6.6 |
- region - OCI region. type: str required: true
more...
|
Supported Version Ranges |
| region |
v7.4.0 -> 7.6.6 |
- oci_region_type - OCI region type. type: str choices: commercial, government
more...
|
Supported Version Ranges |
| oci_region_type |
v6.2.0 -> 7.6.6 |
| [commercial] |
v6.2.0 -> 7.6.6 |
| [government] |
v6.2.0 -> 7.6.6 |
- par_id - Public address range ID. type: str
more...
|
Supported Version Ranges |
| par_id |
v7.6.5 -> 7.6.6 |
- password - Password of the remote SDN connector as login credentials. type: str
more...
|
Supported Version Ranges |
| password |
v6.0.0 -> 7.6.6 |
- private_key - Private key of GCP service account. type: str
more...
|
Supported Version Ranges |
| private_key |
v6.0.0 -> 7.6.6 |
- proxy - SDN proxy. Source system.sdn-proxy.name. type: str
more...
|
Supported Version Ranges |
| proxy |
v7.4.0 -> 7.6.6 |
- region - AWS / ACS region name. type: str
more...
|
Supported Version Ranges |
| region |
v6.0.0 -> 7.6.6 |
- resource_group - Azure resource group. type: str
more...
|
Supported Version Ranges |
| resource_group |
v6.0.0 -> 7.6.6 |
- resource_url - Azure Stack resource URL. type: str
more...
|
Supported Version Ranges |
| resource_url |
v6.0.0 -> 7.6.6 |
- route - Configure GCP route. type: list member_path: route:name
more...
| Supported Version Ranges |
| route |
v6.0.0 -> 7.6.6 |
- name - Route name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- route_table - Configure Azure route table. type: list member_path: route_table:name
more...
| Supported Version Ranges |
| route_table |
v6.0.0 -> 7.6.6 |
- name - Route table name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- resource_group - Resource group of Azure route table. type: str
more...
|
Supported Version Ranges |
| resource_group |
v6.2.0 -> 7.6.6 |
- route - Configure Azure route. type: list member_path: route_table:name/route:name
more...
| Supported Version Ranges |
| route |
v6.0.0 -> 7.6.6 |
- name - Route name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- next_hop - Next hop address. type: str
more...
|
Supported Version Ranges |
| next_hop |
v6.0.0 -> 7.6.6 |
- subscription_id - Subscription ID of Azure route table. type: str
more...
|
Supported Version Ranges |
| subscription_id |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- secret_key - AWS / ACS secret access key. type: str
more...
|
Supported Version Ranges |
| secret_key |
v6.0.0 -> 7.6.6 |
- secret_token - Secret token of Kubernetes service account. type: str
more...
|
Supported Version Ranges |
| secret_token |
v6.2.0 -> 7.6.6 |
- server - Server address of the remote SDN connector. type: str
more...
|
Supported Version Ranges |
| server |
v6.0.0 -> 7.6.6 |
- server_ca_cert - Trust only those servers whose certificate is directly/indirectly signed by this certificate. Source certificate.remote.name certificate .ca.name. type: str
more...
|
Supported Version Ranges |
| server_ca_cert |
v7.2.4 -> 7.6.6 |
- server_cert - Trust servers that contain this certificate only. Source certificate.remote.name. type: str
more...
|
Supported Version Ranges |
| server_cert |
v7.2.4 -> 7.6.6 |
- server_list - Server address list of the remote SDN connector. type: list member_path: server_list:ip
more...
| Supported Version Ranges |
| server_list |
v6.4.4 -> 7.6.6 |
- ip - IPv4 address. type: str required: true
more...
|
Supported Version Ranges |
| ip |
v6.4.4 -> 7.6.6 |
- server_port - Port number of the remote SDN connector. type: int
more...
|
Supported Version Ranges |
| server_port |
v6.0.0 -> 7.6.6 |
- service_account - GCP service account email. type: str
more...
|
Supported Version Ranges |
| service_account |
v6.0.0 -> 7.6.6 |
- status - Enable/disable connection to the remote SDN connector. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- subscription_id - Azure subscription ID. type: str
more...
|
Supported Version Ranges |
| subscription_id |
v6.0.0 -> 7.6.6 |
- tenant_id - Tenant ID (directory ID). type: str
more...
|
Supported Version Ranges |
| tenant_id |
v6.0.0 -> 7.6.6 |
- type - Type of SDN connector. type: str choices: aci, alicloud, aws, azure, gcp, nsx, nuage, oci, openstack, kubernetes, vmware, sepm, aci-direct, ibm, nutanix, sap
more...
|
Supported Version Ranges |
| type |
v6.0.0 -> 7.6.6 |
| [aci] |
v6.0.0 -> 7.6.6 |
| [alicloud] |
v6.2.0 -> 7.6.6 |
| [aws] |
v6.0.0 -> 7.6.6 |
| [azure] |
v6.0.0 -> 7.6.6 |
| [gcp] |
v6.0.0 -> 7.6.6 |
| [nsx] |
v6.0.0 -> 7.6.6 |
| [nuage] |
v6.0.0 -> 7.6.6 |
| [oci] |
v6.0.0 -> 7.6.6 |
| [openstack] |
v6.0.0 -> 7.6.6 |
| [kubernetes] |
v6.2.0 -> 7.6.6 |
| [vmware] |
v6.2.0 -> 7.6.6 |
| [sepm] |
v6.2.0 -> 7.6.6 |
| [aci-direct] |
v6.4.0 -> 7.6.6 |
| [ibm] |
v6.4.0 -> 7.6.6 |
| [nutanix] |
v7.0.0 -> 7.6.6 |
| [sap] |
v7.2.1 -> 7.6.6 |
- update_interval - Dynamic object update interval (30 - 3600 sec). type: int
more...
|
Supported Version Ranges |
| update_interval |
v6.0.0 -> 7.6.6 |
- use_metadata_iam - Enable/disable use of IAM role from metadata to call API. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| use_metadata_iam |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- user_id - User ID. type: str
more...
|
Supported Version Ranges |
| user_id |
v6.0.0 -> 7.6.6 |
- username - Username of the remote SDN connector as login credentials. type: str
more...
|
Supported Version Ranges |
| username |
v6.0.0 -> 7.6.6 |
- vcenter_password - vCenter server password for NSX quarantine. type: str
more...
|
Supported Version Ranges |
| vcenter_password |
v6.4.0 -> 7.6.6 |
- vcenter_server - vCenter server address for NSX quarantine. type: str
more...
|
Supported Version Ranges |
| vcenter_server |
v6.4.0 -> 7.6.6 |
- vcenter_username - vCenter server username for NSX quarantine. type: str
more...
|
Supported Version Ranges |
| vcenter_username |
v6.4.0 -> 7.6.6 |
- vdom - Virtual domain name of the remote SDN connector. Source system.vdom.name. type: str
more...
|
Supported Version Ranges |
| vdom |
v7.6.3 -> 7.6.6 |
- verify_certificate - Enable/disable server certificate verification. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| verify_certificate |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
- vpc_id - AWS VPC ID. type: str
more...
|
Supported Version Ranges |
| vpc_id |
v6.0.0 -> 7.6.6 |
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.