Docs4dev
Docs
ansible / 2.11 / collections / fortinet / fortimanager / fmgr_system_sdnconnector_module.html

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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_sdnconnector.

New in version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_sdnconnector
dictionary
the top level parameters set
_local_cert
string
no description
access-key
string
AWS access key ID.
azure-region
string
    Choices:
  • global
  • china
  • germany
  • usgov
  • local
Azure server region.
client-id
string
Azure client ID (application ID).
client-secret
string
no description
compartment-id
string
Compartment ID.
external-ip
list / elements=string
no description
name
string
External IP name.
gcp-project
string
GCP project name.
key-passwd
string
no description
login-endpoint
string
Azure Stack login enpoint.
name
string
SDN connector name.
nic
list / elements=string
no description
ip
list / elements=string
no description
name
string
IP configuration name.
public-ip
string
Public IP name.
name
string
Network interface name.
nsx-cert-fingerprint
string
NSX certificate fingerprint.
oci-cert
string
OCI certificate.
oci-fingerprint
string
no description
oci-region
string
    Choices:
  • phoenix
  • ashburn
  • frankfurt
  • london
  • toronto
OCI server region.
password
string
no description
private-key
string
Private key of GCP service account.
region
string
AWS region name.
resource-group
string
Azure resource group.
resource-url
string
Azure Stack resource URL.
rest-interface
string
    Choices:
  • mgmt
  • sync
Interface name for REST service to listen on.
rest-password
string
no description
rest-sport
integer
REST service access port (1 - 65535).
rest-ssl
string
    Choices:
  • disable
  • enable
no description
route
list / elements=string
no description
name
string
Route name.
route-table
list / elements=string
no description
name
string
Route table name.
route
list / elements=string
no description
name
string
Route name.
next-hop
string
Next hop address.
secret-key
string
no description
server
string
Server address of the remote SDN connector.
server-port
integer
Port number of the remote SDN connector.
service-account
string
GCP service account email.
status
string
    Choices:
  • disable
  • enable
Enable/disable connection to the remote SDN connector.
subscription-id
string
Azure subscription ID.
tenant-id
string
Tenant ID (directory ID).
type
string
    Choices:
  • aci
  • aws
  • nsx
  • nuage
  • azure
  • gcp
  • oci
  • openstack
  • kubernetes
  • vmware
  • acs
  • alicloud
Type of SDN connector.
update-interval
integer
Dynamic object update interval (0 - 3600 sec, 0 means disabled, default = 60).
use-metadata-iam
string
    Choices:
  • disable
  • enable
Enable/disable using IAM role from metadata to call API.
user-id
string
User ID.
username
string
Username of the remote SDN connector as login credentials.
vmx-image-url
string
URL of web-hosted VMX image.
vmx-service-name
string
VMX Service name.
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure connection to SDN Connector.
     fmgr_system_sdnconnector:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        system_sdnconnector:
           _local_cert: <value of string>
           access-key: <value of string>
           azure-region: <value in [global, china, germany, ...]>
           client-id: <value of string>
           client-secret: <value of string>
           compartment-id: <value of string>
           external-ip:
             -
                 name: <value of string>
           gcp-project: <value of string>
           key-passwd: <value of string>
           login-endpoint: <value of string>
           name: <value of string>
           nic:
             -
                 ip:
                   -
                       name: <value of string>
                       public-ip: <value of string>
                 name: <value of string>
           nsx-cert-fingerprint: <value of string>
           oci-cert: <value of string>
           oci-fingerprint: <value of string>
           oci-region: <value in [phoenix, ashburn, frankfurt, ...]>
           password: <value of string>
           private-key: <value of string>
           region: <value of string>
           resource-group: <value of string>
           resource-url: <value of string>
           rest-interface: <value in [mgmt, sync]>
           rest-password: <value of string>
           rest-sport: <value of integer>
           rest-ssl: <value in [disable, enable]>
           route:
             -
                 name: <value of string>
           route-table:
             -
                 name: <value of string>
                 route:
                   -
                       name: <value of string>
                       next-hop: <value of string>
           secret-key: <value of string>
           server: <value of string>
           server-port: <value of integer>
           service-account: <value of string>
           status: <value in [disable, enable]>
           subscription-id: <value of string>
           tenant-id: <value of string>
           type: <value in [aci, aws, nsx, ...]>
           update-interval: <value of integer>
           use-metadata-iam: <value in [disable, enable]>
           user-id: <value of string>
           username: <value of string>
           vmx-image-url: <value of string>
           vmx-service-name: <value of string>
           vpc-id: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_sdnconnector_module.html