fmgr_system_sdnconnector – Configure connection to SDN Connector.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- system_sdnconnector - Configure connection to SDN Connector. type: dict
- _local_cert - No description for the parameter type: str
- access-key - AWS access key ID. type: str
- azure-region - Azure server region. type: str choices: [global, china, germany, usgov, local]
- client-id - Azure client ID (application ID). type: str
- client-secret - No description for the parameter type: str
- compartment-id - Compartment ID. type: str
- external-ip - No description for the parameter type: array
- name - External IP name. type: str
- gcp-project - GCP project name. type: str
- key-passwd - No description for the parameter type: str
- login-endpoint - Azure Stack login enpoint. type: str
- name - SDN connector name. type: str
- nic - No description for the parameter type: array
- ip - No description for the parameter type: array
- name - IP configuration name. type: str
- public-ip - Public IP name. type: str
- name - Network interface name. type: str
- ip - No description for the parameter type: array
- nsx-cert-fingerprint - NSX certificate fingerprint. type: str
- oci-cert - OCI certificate. type: str
- oci-fingerprint - No description for the parameter type: str
- oci-region - OCI server region. type: str choices: [phoenix, ashburn, frankfurt, london, toronto]
- password - No description for the parameter type: str
- private-key - Private key of GCP service account. type: str
- region - AWS region name. type: str
- resource-group - Azure resource group. type: str
- resource-url - Azure Stack resource URL. type: str
- rest-interface - Interface name for REST service to listen on. type: str choices: [mgmt, sync]
- rest-password - No description for the parameter type: str
- rest-sport - REST service access port (1 - 65535). type: int
- rest-ssl - No description for the parameter type: str choices: [disable, enable]
- route - No description for the parameter type: array
- name - Route name. type: str
- route-table - No description for the parameter type: array
- name - Route table name. type: str
- route - No description for the parameter type: array
- name - Route name. type: str
- next-hop - Next hop address. type: str
- secret-key - No description for the parameter type: str
- server - Server address of the remote SDN connector. type: str
- server-port - Port number of the remote SDN connector. type: int
- service-account - GCP service account email. type: str
- status - Enable/disable connection to the remote SDN connector. type: str choices: [disable, enable]
- subscription-id - Azure subscription ID. type: str
- tenant-id - Tenant ID (directory ID). type: str
- type - Type of SDN connector. type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack, kubernetes, vmware, acs, alicloud]
- update-interval - Dynamic object update interval (0 - 3600 sec, 0 means disabled, default = 60). type: int
- use-metadata-iam - Enable/disable using IAM role from metadata to call API. type: str choices: [disable, enable]
- user-id - User ID. type: str
- username - Username of the remote SDN connector as login credentials. type: str
- vmx-image-url - URL of web-hosted VMX image. type: str
- vmx-service-name - VMX Service name. type: str
- vpc-id - AWS VPC ID. type: str
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict