fortinet.fortimanager.fmgr_system_sdnconnector module – Configure connection to SDN Connector.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_sdnconnector
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Local cert. |
|
AWS access key ID. |
|
Enable/disable AWS alternative resource IP. Choices:
|
|
(list) IBM cloud API key or service ID API key. |
|
Azure server region. Choices:
|
|
Azure client ID |
|
(list) Azure client secret |
|
Compartment ID. |
|
Compartment list. |
|
OCI compartment ID. |
|
Compute generation for IBM cloud infrastructure. |
|
Openstack domain. |
|
External account list. |
|
AWS external ID. |
|
(list) AWS region name list. |
|
AWS role ARN to assume. |
|
External ip. |
|
External IP name. |
|
Forwarding rule. |
|
Forwarding rule name. |
|
Target instance name. |
|
GCP project name. |
|
Gcp project list. |
|
(list) Configure GCP zone list. |
|
GCP project ID. |
|
Group name of computers. |
|
Enable/disable use for FortiGate HA service. Choices:
|
|
IBM cloud region name. Choices:
|
|
Ibm region gen1. Choices:
|
|
Ibm region gen2. Choices:
|
|
(list) Private key password. |
|
Last update. |
|
Azure Stack login enpoint. |
|
SDN connector name. |
|
Nic. |
|
Ip. |
|
IP configuration name. |
|
Private IP address. |
|
Public IP name. |
|
Resource group of Azure public IP. |
|
Network interface name. |
|
Peer network interface name. |
|
NSX certificate fingerprint. |
|
OCI certificate. |
|
Oci fingerprint. |
|
OCI server region. Choices:
|
|
Oci region list. |
|
OCI region. |
|
OCI region type. Choices:
|
|
(list) Password of the remote SDN connector as login credentials. |
|
Private key of GCP service account. |
|
SDN proxy. |
|
AWS region name. |
|
Azure resource group. |
|
Azure Stack resource URL. |
|
Interface name for REST service to listen on. Choices:
|
|
(list) Password for REST service. |
|
REST service access port |
|
Rest ssl. Choices:
|
|
Route. |
|
Route name. |
|
Route table. |
|
Route table name. |
|
Resource group of Azure route table. |
|
Route. |
|
Route name. |
|
Next hop address. |
|
Subscription ID of Azure route table. |
|
(list) AWS secret access key. |
|
Secret token of Kubernetes service account. |
|
Server address of the remote SDN connector. |
|
Trust only those servers whose certificate is directly/indirectly signed by this certificate. |
|
Trust servers that contain this certificate only. |
|
IP address of the remote SDN connector. |
|
(list) Server address list of the remote SDN connector. |
|
Port number of the remote SDN connector. |
|
GCP service account email. |
|
Enable/disable connection to the remote SDN connector. Choices:
|
|
Azure subscription ID. |
|
Tenant ID |
|
Type of SDN connector. Choices:
|
|
Dynamic object update interval |
|
Updating. |
|
Enable/disable using IAM role from metadata to call API. Choices:
|
|
User ID. |
|
Username of the remote SDN connector as login credentials. |
|
(list) VCenter server password for NSX quarantine. |
|
VCenter server address for NSX quarantine. |
|
VCenter server username for NSX quarantine. |
|
Enable/disable server certificate verification. Choices:
|
|
URL of web-hosted VMX image. |
|
VMX Service name. |
|
AWS VPC ID. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure connection to SDN Connector.
fortinet.fortimanager.fmgr_system_sdnconnector:
bypass_validation: false
adom: ansible
state: present
system_sdnconnector:
azure-region: global # <value in [global, china, germany, ...]>
# compartment-id: 1
name: ansible-test-sdn
password: fortinet
server: ALL
status: disable
type: aws # <value in [aci, aws, nsx, ...]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the connections to SDN Connector
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_sdnconnector"
params:
adom: "ansible"
sdn-connector: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |