fortinet.fortimanager.fmgr_system_sdnconnector module – Configure connection to SDN Connector.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

system_sdnconnector

dictionary

The top level parameters set.

_local_cert

string

_Local_Cert.

access-key

string

Deprecated, please rename it to access_key. AWS access key ID.

alt-resource-ip

string

Deprecated, please rename it to alt_resource_ip. Enable/disable AWS alternative resource IP.

Choices:

  • "disable"

  • "enable"

api-key

any

(list) Deprecated, please rename it to api_key. IBM cloud API key or service ID API key.

azure-region

string

Deprecated, please rename it to azure_region. Azure server region.

Choices:

  • "global"

  • "china"

  • "germany"

  • "usgov"

  • "local"

client-id

string

Deprecated, please rename it to client_id. Azure client ID

client-secret

any

(list) Deprecated, please rename it to client_secret. Azure client secret

compartment-id

string

Deprecated, please rename it to compartment_id. Compartment ID.

compartment-list

list / elements=dictionary

Deprecated, please rename it to compartment_list.

compartment-id

string

Deprecated, please rename it to compartment_id. OCI compartment ID.

compute-generation

integer

Deprecated, please rename it to compute_generation. Compute generation for IBM cloud infrastructure.

domain

string

Openstack domain.

external-account-list

list / elements=dictionary

Deprecated, please rename it to external_account_list.

external-id

string

Deprecated, please rename it to external_id. AWS external ID.

region-list

any

(list) Deprecated, please rename it to region_list.

role-arn

string

Deprecated, please rename it to role_arn. AWS role ARN to assume.

external-ip

list / elements=dictionary

Deprecated, please rename it to external_ip. External-Ip.

name

string

External IP name.

forwarding-rule

list / elements=dictionary

Deprecated, please rename it to forwarding_rule.

rule-name

string

Deprecated, please rename it to rule_name. Forwarding rule name.

target

string

Target instance name.

gcp-project

string

Deprecated, please rename it to gcp_project. GCP project name.

gcp-project-list

list / elements=dictionary

Deprecated, please rename it to gcp_project_list.

gcp-zone-list

any

(list) Deprecated, please rename it to gcp_zone_list.

id

string

GCP project ID.

group-name

string

Deprecated, please rename it to group_name. Group name of computers.

ha-status

string

Deprecated, please rename it to ha_status. Enable/disable use for FortiGate HA service.

Choices:

  • "disable"

  • "enable"

ibm-region

string

Deprecated, please rename it to ibm_region. IBM cloud region name.

Choices:

  • "us-south"

  • "us-east"

  • "germany"

  • "great-britain"

  • "japan"

  • "australia"

  • "dallas"

  • "washington-dc"

  • "london"

  • "frankfurt"

  • "sydney"

  • "tokyo"

  • "osaka"

  • "toronto"

  • "sao-paulo"

  • "dallas-private"

  • "washington-dc-private"

  • "london-private"

  • "frankfurt-private"

  • "sydney-private"

  • "tokyo-private"

  • "osaka-private"

  • "toronto-private"

  • "sao-paulo-private"

ibm-region-gen1

string

Deprecated, please rename it to ibm_region_gen1. Ibm-Region-Gen1.

Choices:

  • "us-south"

  • "us-east"

  • "germany"

  • "great-britain"

  • "japan"

  • "australia"

ibm-region-gen2

string

Deprecated, please rename it to ibm_region_gen2. Ibm-Region-Gen2.

Choices:

  • "us-south"

  • "us-east"

  • "great-britain"

key-passwd

any

(list) Deprecated, please rename it to key_passwd. Private key password.

last-update

integer

Deprecated, please rename it to last_update. Last-Update.

login-endpoint

string

Deprecated, please rename it to login_endpoint. Azure Stack login enpoint.

name

string / required

SDN connector name.

nic

list / elements=dictionary

Nic.

ip

list / elements=dictionary

Ip.

name

string

IP configuration name.

public-ip

string

Deprecated, please rename it to public_ip. Public IP name.

resource-group

string

Deprecated, please rename it to resource_group. Resource group of Azure public IP.

name

string

Network interface name.

nsx-cert-fingerprint

string

Deprecated, please rename it to nsx_cert_fingerprint. NSX certificate fingerprint.

oci-cert

string

Deprecated, please rename it to oci_cert. OCI certificate.

oci-fingerprint

string

Deprecated, please rename it to oci_fingerprint. Oci-Fingerprint.

oci-region

string

Deprecated, please rename it to oci_region. OCI server region.

Choices:

  • "phoenix"

  • "ashburn"

  • "frankfurt"

  • "london"

  • "toronto"

oci-region-list

list / elements=dictionary

Deprecated, please rename it to oci_region_list.

region

string

OCI region.

oci-region-type

string

Deprecated, please rename it to oci_region_type. OCI region type.

Choices:

  • "commercial"

  • "government"

password

any

(list) Password of the remote SDN connector as login credentials.

private-key

string

Deprecated, please rename it to private_key. Private key of GCP service account.

proxy

string

SDN proxy.

region

string

AWS region name.

resource-group

string

Deprecated, please rename it to resource_group. Azure resource group.

resource-url

string

Deprecated, please rename it to resource_url. Azure Stack resource URL.

rest-interface

string

Deprecated, please rename it to rest_interface. Interface name for REST service to listen on.

Choices:

  • "mgmt"

  • "sync"

rest-password

any

(list) Deprecated, please rename it to rest_password. Password for REST service.

rest-sport

integer

Deprecated, please rename it to rest_sport. REST service access port

rest-ssl

string

Deprecated, please rename it to rest_ssl. Rest-Ssl.

Choices:

  • "disable"

  • "enable"

route

list / elements=dictionary

Route.

name

string

Route name.

route-table

list / elements=dictionary

Deprecated, please rename it to route_table. Route-Table.

name

string

Route table name.

resource-group

string

Deprecated, please rename it to resource_group. Resource group of Azure route table.

route

list / elements=dictionary

Route.

name

string

Route name.

next-hop

string

Deprecated, please rename it to next_hop. Next hop address.

subscription-id

string

Deprecated, please rename it to subscription_id. Subscription ID of Azure route table.

secret-key

any

(list) Deprecated, please rename it to secret_key. AWS / ACS secret access key.

secret-token

string

Deprecated, please rename it to secret_token. Secret token of Kubernetes service account.

server

string

Server address of the remote SDN connector.

server-ca-cert

string

Deprecated, please rename it to server_ca_cert. Trust only those servers whose certificate is directly/indirectly signed b…

server-cert

string

Deprecated, please rename it to server_cert. Trust servers that contain this certificate only.

server-ip

string

Deprecated, please rename it to server_ip. IP address of the remote SDN connector.

server-list

any

(list) Deprecated, please rename it to server_list. Server address list of the remote SDN connector.

server-port

integer

Deprecated, please rename it to server_port. Port number of the remote SDN connector.

service-account

string

Deprecated, please rename it to service_account. GCP service account email.

status

string

Enable/disable connection to the remote SDN connector.

Choices:

  • "disable"

  • "enable"

subscription-id

string

Deprecated, please rename it to subscription_id. Azure subscription ID.

tenant-id

string

Deprecated, please rename it to tenant_id. Tenant ID

type

string

Type of SDN connector.

Choices:

  • "aci"

  • "aws"

  • "nsx"

  • "nuage"

  • "azure"

  • "gcp"

  • "oci"

  • "openstack"

  • "kubernetes"

  • "vmware"

  • "acs"

  • "alicloud"

  • "sepm"

  • "aci-direct"

  • "ibm"

  • "nutanix"

  • "sap"

update-interval

integer

Deprecated, please rename it to update_interval. Dynamic object update interval

updating

integer

Updating.

use-metadata-iam

string

Deprecated, please rename it to use_metadata_iam. Enable/disable using IAM role from metadata to call API.

Choices:

  • "disable"

  • "enable"

user-id

string

Deprecated, please rename it to user_id. User ID.

username

string

Username of the remote SDN connector as login credentials.

vcenter-password

any

(list) Deprecated, please rename it to vcenter_password. VCenter server password for NSX quarantine.

vcenter-server

string

Deprecated, please rename it to vcenter_server. VCenter server address for NSX quarantine.

vcenter-username

string

Deprecated, please rename it to vcenter_username. VCenter server username for NSX quarantine.

verify-certificate

string

Deprecated, please rename it to verify_certificate. Enable/disable server certificate verification.

Choices:

  • "disable"

  • "enable"

vmx-image-url

string

Deprecated, please rename it to vmx_image_url. URL of web-hosted VMX image.

vmx-service-name

string

Deprecated, please rename it to vmx_service_name. VMX Service name.

vpc-id

string

Deprecated, please rename it to vpc_id. AWS VPC ID.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)