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

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

aliases: access-key

string

AWS access key ID.

alt_resource_ip

aliases: alt-resource-ip

string

Enable/disable AWS alternative resource IP.

Choices:

  • "disable"

  • "enable"

api_key

aliases: api-key

any

(list) IBM cloud API key or service ID API key.

azure_region

aliases: azure-region

string

Azure server region.

Choices:

  • "global"

  • "china"

  • "germany"

  • "usgov"

  • "local"

client_id

aliases: client-id

string

Azure client ID

client_secret

aliases: client-secret

any

(list) Azure client secret

compartment_id

aliases: compartment-id

string

Compartment ID.

compartment_list

aliases: compartment-list

list / elements=dictionary

Compartment list.

compartment_id

aliases: compartment-id

string

OCI compartment ID.

compute_generation

aliases: compute-generation

integer

Compute generation for IBM cloud infrastructure.

domain

string

Openstack domain.

external_account_list

aliases: external-account-list

list / elements=dictionary

External account list.

external_id

aliases: external-id

string

AWS external ID.

region_list

aliases: region-list

any

(list) AWS region name list.

role_arn

aliases: role-arn

string

AWS role ARN to assume.

external_ip

aliases: external-ip

list / elements=dictionary

External ip.

name

string

External IP name.

forwarding_rule

aliases: forwarding-rule

list / elements=dictionary

Forwarding rule.

rule_name

aliases: rule-name

string

Forwarding rule name.

target

string

Target instance name.

gcp_project

aliases: gcp-project

string

GCP project name.

gcp_project_list

aliases: gcp-project-list

list / elements=dictionary

Gcp project list.

gcp_zone_list

aliases: gcp-zone-list

any

(list) Configure GCP zone list.

id

string

GCP project ID.

group_name

aliases: group-name

string

Group name of computers.

ha_status

aliases: ha-status

string

Enable/disable use for FortiGate HA service.

Choices:

  • "disable"

  • "enable"

ibm_region

aliases: ibm-region

string

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

aliases: ibm-region-gen1

string

Ibm region gen1.

Choices:

  • "us-south"

  • "us-east"

  • "germany"

  • "great-britain"

  • "japan"

  • "australia"

ibm_region_gen2

aliases: ibm-region-gen2

string

Ibm region gen2.

Choices:

  • "us-south"

  • "us-east"

  • "great-britain"

key_passwd

aliases: key-passwd

any

(list) Private key password.

last_update

aliases: last-update

integer

Last update.

login_endpoint

aliases: login-endpoint

string

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.

private_ip

aliases: private-ip

string

Private IP address.

public_ip

aliases: public-ip

string

Public IP name.

resource_group

aliases: resource-group

string

Resource group of Azure public IP.

name

string

Network interface name.

peer_nic

aliases: peer-nic

string

Peer network interface name.

nsx_cert_fingerprint

aliases: nsx-cert-fingerprint

string

NSX certificate fingerprint.

oci_cert

aliases: oci-cert

string

OCI certificate.

oci_fingerprint

aliases: oci-fingerprint

string

Oci fingerprint.

oci_region

aliases: oci-region

string

OCI server region.

Choices:

  • "phoenix"

  • "ashburn"

  • "frankfurt"

  • "london"

  • "toronto"

oci_region_list

aliases: oci-region-list

list / elements=dictionary

Oci region list.

region

string

OCI region.

oci_region_type

aliases: oci-region-type

string

OCI region type.

Choices:

  • "commercial"

  • "government"

password

any

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

private_key

aliases: private-key

string

Private key of GCP service account.

proxy

string

SDN proxy.

region

string

AWS region name.

resource_group

aliases: resource-group

string

Azure resource group.

resource_url

aliases: resource-url

string

Azure Stack resource URL.

rest_interface

aliases: rest-interface

string

Interface name for REST service to listen on.

Choices:

  • "mgmt"

  • "sync"

rest_password

aliases: rest-password

any

(list) Password for REST service.

rest_sport

aliases: rest-sport

integer

REST service access port

rest_ssl

aliases: rest-ssl

string

Rest ssl.

Choices:

  • "disable"

  • "enable"

route

list / elements=dictionary

Route.

name

string

Route name.

route_table

aliases: route-table

list / elements=dictionary

Route table.

name

string

Route table name.

resource_group

aliases: resource-group

string

Resource group of Azure route table.

route

list / elements=dictionary

Route.

name

string

Route name.

next_hop

aliases: next-hop

string

Next hop address.

subscription_id

aliases: subscription-id

string

Subscription ID of Azure route table.

secret_key

aliases: secret-key

any

(list) AWS secret access key.

secret_token

aliases: secret-token

string

Secret token of Kubernetes service account.

server

string

Server address of the remote SDN connector.

server_ca_cert

aliases: server-ca-cert

string

Trust only those servers whose certificate is directly/indirectly signed by this certificate.

server_cert

aliases: server-cert

string

Trust servers that contain this certificate only.

server_ip

aliases: server-ip

string

IP address of the remote SDN connector.

server_list

aliases: server-list

any

(list) Server address list of the remote SDN connector.

server_port

aliases: server-port

integer

Port number of the remote SDN connector.

service_account

aliases: service-account

string

GCP service account email.

status

string

Enable/disable connection to the remote SDN connector.

Choices:

  • "disable"

  • "enable"

subscription_id

aliases: subscription-id

string

Azure subscription ID.

tenant_id

aliases: tenant-id

string

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

aliases: update-interval

integer

Dynamic object update interval

updating

integer

Updating.

use_metadata_iam

aliases: use-metadata-iam

string

Enable/disable using IAM role from metadata to call API.

Choices:

  • "disable"

  • "enable"

user_id

aliases: user-id

string

User ID.

username

string

Username of the remote SDN connector as login credentials.

vcenter_password

aliases: vcenter-password

any

(list) VCenter server password for NSX quarantine.

vcenter_server

aliases: vcenter-server

string

VCenter server address for NSX quarantine.

vcenter_username

aliases: vcenter-username

string

VCenter server username for NSX quarantine.

verify_certificate

aliases: verify-certificate

string

Enable/disable server certificate verification.

Choices:

  • "disable"

  • "enable"

vmx_image_url

aliases: vmx-image-url

string

URL of web-hosted VMX image.

vmx_service_name

aliases: vmx-service-name

string

VMX Service name.

vpc_id

aliases: vpc-id

string

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)