fortinet.fortimanager.fmgr_system_sdnconnector module – Configure connection to SDN Connector.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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. |
|
Deprecated, please rename it to access_key. AWS access key ID. |
|
Deprecated, please rename it to alt_resource_ip. Enable/disable AWS alternative resource IP. Choices:
|
|
(list) Deprecated, please rename it to api_key. IBM cloud API key or service ID API key. |
|
Deprecated, please rename it to azure_region. Azure server region. Choices:
|
|
Deprecated, please rename it to client_id. Azure client ID |
|
(list) Deprecated, please rename it to client_secret. Azure client secret |
|
Deprecated, please rename it to compartment_id. Compartment ID. |
|
Deprecated, please rename it to compartment_list. Compartment list. |
|
Deprecated, please rename it to compartment_id. OCI compartment ID. |
|
Deprecated, please rename it to compute_generation. Compute generation for IBM cloud infrastructure. |
|
Openstack domain. |
|
Deprecated, please rename it to external_account_list. External account list. |
|
Deprecated, please rename it to external_id. AWS external ID. |
|
(list) Deprecated, please rename it to region_list. AWS region name list. |
|
Deprecated, please rename it to role_arn. AWS role ARN to assume. |
|
Deprecated, please rename it to external_ip. External ip. |
|
External IP name. |
|
Deprecated, please rename it to forwarding_rule. Forwarding rule. |
|
Deprecated, please rename it to rule_name. Forwarding rule name. |
|
Target instance name. |
|
Deprecated, please rename it to gcp_project. GCP project name. |
|
Deprecated, please rename it to gcp_project_list. Gcp project list. |
|
(list) Deprecated, please rename it to gcp_zone_list. Configure GCP zone list. |
|
GCP project ID. |
|
Deprecated, please rename it to group_name. Group name of computers. |
|
Deprecated, please rename it to ha_status. Enable/disable use for FortiGate HA service. Choices:
|
|
Deprecated, please rename it to ibm_region. IBM cloud region name. Choices:
|
|
Deprecated, please rename it to ibm_region_gen1. Ibm region gen1. Choices:
|
|
Deprecated, please rename it to ibm_region_gen2. Ibm region gen2. Choices:
|
|
(list) Deprecated, please rename it to key_passwd. Private key password. |
|
Deprecated, please rename it to last_update. Last update. |
|
Deprecated, please rename it to login_endpoint. Azure Stack login enpoint. |
|
SDN connector name. |
|
Nic. |
|
Ip. |
|
IP configuration name. |
|
Deprecated, please rename it to public_ip. Public IP name. |
|
Deprecated, please rename it to resource_group. Resource group of Azure public IP. |
|
Network interface name. |
|
Deprecated, please rename it to nsx_cert_fingerprint. NSX certificate fingerprint. |
|
Deprecated, please rename it to oci_cert. OCI certificate. |
|
Deprecated, please rename it to oci_fingerprint. Oci fingerprint. |
|
Deprecated, please rename it to oci_region. OCI server region. Choices:
|
|
Deprecated, please rename it to oci_region_list. Oci region list. |
|
OCI region. |
|
Deprecated, please rename it to oci_region_type. OCI region type. Choices:
|
|
(list) Password of the remote SDN connector as login credentials. |
|
Deprecated, please rename it to private_key. Private key of GCP service account. |
|
SDN proxy. |
|
AWS region name. |
|
Deprecated, please rename it to resource_group. Azure resource group. |
|
Deprecated, please rename it to resource_url. Azure Stack resource URL. |
|
Deprecated, please rename it to rest_interface. Interface name for REST service to listen on. Choices:
|
|
(list) Deprecated, please rename it to rest_password. Password for REST service. |
|
Deprecated, please rename it to rest_sport. REST service access port |
|
Deprecated, please rename it to rest_ssl. Rest ssl. Choices:
|
|
Route. |
|
Route name. |
|
Deprecated, please rename it to route_table. Route table. |
|
Route table name. |
|
Deprecated, please rename it to resource_group. Resource group of Azure route table. |
|
Route. |
|
Route name. |
|
Deprecated, please rename it to next_hop. Next hop address. |
|
Deprecated, please rename it to subscription_id. Subscription ID of Azure route table. |
|
(list) Deprecated, please rename it to secret_key. AWS secret access key. |
|
Deprecated, please rename it to secret_token. Secret token of Kubernetes service account. |
|
Server address of the remote SDN connector. |
|
Deprecated, please rename it to server_ca_cert. Trust only those servers whose certificate is directly/indirectly signed b… |
|
Deprecated, please rename it to server_cert. Trust servers that contain this certificate only. |
|
Deprecated, please rename it to server_ip. IP address of the remote SDN connector. |
|
(list) Deprecated, please rename it to server_list. Server address list of the remote SDN connector. |
|
Deprecated, please rename it to server_port. Port number of the remote SDN connector. |
|
Deprecated, please rename it to service_account. GCP service account email. |
|
Enable/disable connection to the remote SDN connector. Choices:
|
|
Deprecated, please rename it to subscription_id. Azure subscription ID. |
|
Deprecated, please rename it to tenant_id. Tenant ID |
|
Type of SDN connector. Choices:
|
|
Deprecated, please rename it to update_interval. Dynamic object update interval |
|
Updating. |
|
Deprecated, please rename it to use_metadata_iam. Enable/disable using IAM role from metadata to call API. Choices:
|
|
Deprecated, please rename it to user_id. User ID. |
|
Username of the remote SDN connector as login credentials. |
|
(list) Deprecated, please rename it to vcenter_password. VCenter server password for NSX quarantine. |
|
Deprecated, please rename it to vcenter_server. VCenter server address for NSX quarantine. |
|
Deprecated, please rename it to vcenter_username. VCenter server username for NSX quarantine. |
|
Deprecated, please rename it to verify_certificate. Enable/disable server certificate verification. Choices:
|
|
Deprecated, please rename it to vmx_image_url. URL of web-hosted VMX image. |
|
Deprecated, please rename it to vmx_service_name. VMX Service name. |
|
Deprecated, please rename it to vpc_id. 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 |