fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc¶
New in version 2.2.0.
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.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| False | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| False | False | False | False | False | False | False | False | False | False | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
| False | False | False | False | False | False | False | False | False | False | False | False |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
| False | False | False | False | False | False | False | False | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| False | False | False | |||||||||
7.4.0 |
|||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- adom - The parameter in requested url type: str required: true
- cloud_orchestawstemplate_autoscaletgwnewvpc - no description type: dict
- availability-zones - No description for the parameter type: str more...
- bgp-asn - No description for the parameter type: int default: 65000 more...
- custom-asset-container - No description for the parameter type: str default: more...
- custom-asset-directory - No description for the parameter type: str default: more...
- custom-identifier - No description for the parameter type: str default: fgtASG more...
- faz-autoscale-admin-password - No description for the parameter type: str more...
- faz-autoscale-admin-username - No description for the parameter type: str default: more...
- faz-custom-private-ipaddress - No description for the parameter type: str default: more...
- faz-instance-type - No description for the parameter type: str choices: [h1.2xlarge, h1.4xlarge, h1.8xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.12xlarge, t2.medium, t2.large, t2.xlarge] default: m5.large more...
- faz-integration-options - No description for the parameter type: str choices: [no, yes] default: no more...
- faz-version - No description for the parameter type: str default: 7.2.0 more...
- fgt-admin-cidr - No description for the parameter type: str default: 0.0.0.0/0 more...
- fgt-admin-port - No description for the parameter type: int default: 8443 more...
- fgt-instance-type - No description for the parameter type: str choices: [t2.small, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge] default: c5.xlarge more...
- fgt-psk-secret - No description for the parameter type: str default: S1c21t@FGT more...
- fgtasg-cool-down - No description for the parameter type: int default: 300 more...
- fgtasg-desired-capacity-byol - No description for the parameter type: int default: 2 more...
- fgtasg-desired-capacity-payg - No description for the parameter type: int default: 0 more...
- fgtasg-health-check-grace-period - No description for the parameter type: int default: 300 more...
- fgtasg-max-size-byol - No description for the parameter type: int default: 2 more...
- fgtasg-max-size-payg - No description for the parameter type: int default: 6 more...
- fgtasg-min-size-byol - No description for the parameter type: int default: 2 more...
- fgtasg-min-size-payg - No description for the parameter type: int default: 0 more...
- fgtasg-scale-in-threshold - No description for the parameter type: int default: 25 more...
- fgtasg-scale-out-threshold - No description for the parameter type: int default: 80 more...
- fos-version - No description for the parameter type: str default: 7.2.4 more...
- get-license-grace-period - No description for the parameter type: int default: 600 more...
- heartbeat-delay-allowance - No description for the parameter type: int default: 2 more...
- heartbeat-interval - No description for the parameter type: int default: 30 more...
- heartbeat-loss-count - No description for the parameter type: int default: 10 more...
- key-pair-name - No description for the parameter type: str more...
- lifecycle-hook-timeout - No description for the parameter type: int default: 480 more...
- name - No description for the parameter type: str more...
- notification-email - No description for the parameter type: str default: more...
- primary-election-timeout - No description for the parameter type: int default: 300 more...
- public-subnet1-cidr - No description for the parameter type: str default: 192.168.0.0/24 more...
- public-subnet2-cidr - No description for the parameter type: str default: 192.168.1.0/24 more...
- resource-tag-prefix - No description for the parameter type: str more...
- s3-bucket-name - No description for the parameter type: str default: more...
- s3-key-prefix - No description for the parameter type: str default: more...
- sync-recovery-count - No description for the parameter type: int default: 3 more...
- terminate-unhealthy-vm - No description for the parameter type: str choices: [no, yes] default: no more...
- transit-gateway-id - No description for the parameter type: str more...
- transit-gateway-support-options - No description for the parameter type: str choices: [create one, use an existing one] default: create one more...
- use-custom-asset-location - No description for the parameter type: str choices: [no, yes] default: no more...
- vpc-cidr - No description for the parameter type: str default: 192.168.0.0/16 more...
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: no description
fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc:
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]>
cloud_orchestawstemplate_autoscaletgwnewvpc:
availability-zones: <value of string>
bgp-asn: <value of integer>
custom-asset-container: <value of string>
custom-asset-directory: <value of string>
custom-identifier: <value of string>
faz-autoscale-admin-password: <value of string>
faz-autoscale-admin-username: <value of string>
faz-custom-private-ipaddress: <value of string>
faz-instance-type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
faz-integration-options: <value in [no, yes]>
faz-version: <value of string>
fgt-admin-cidr: <value of string>
fgt-admin-port: <value of integer>
fgt-instance-type: <value in [t2.small, c5.large, c5.xlarge, ...]>
fgt-psk-secret: <value of string>
fgtasg-cool-down: <value of integer>
fgtasg-desired-capacity-byol: <value of integer>
fgtasg-desired-capacity-payg: <value of integer>
fgtasg-health-check-grace-period: <value of integer>
fgtasg-max-size-byol: <value of integer>
fgtasg-max-size-payg: <value of integer>
fgtasg-min-size-byol: <value of integer>
fgtasg-min-size-payg: <value of integer>
fgtasg-scale-in-threshold: <value of integer>
fgtasg-scale-out-threshold: <value of integer>
fos-version: <value of string>
get-license-grace-period: <value of integer>
heartbeat-delay-allowance: <value of integer>
heartbeat-interval: <value of integer>
heartbeat-loss-count: <value of integer>
key-pair-name: <value of string>
lifecycle-hook-timeout: <value of integer>
name: <value of string>
notification-email: <value of string>
primary-election-timeout: <value of integer>
public-subnet1-cidr: <value of string>
public-subnet2-cidr: <value of string>
resource-tag-prefix: <value of string>
s3-bucket-name: <value of string>
s3-key-prefix: <value of string>
sync-recovery-count: <value of integer>
terminate-unhealthy-vm: <value in [no, yes]>
transit-gateway-id: <value of string>
transit-gateway-support-options: <value in [create one, use an existing one]>
use-custom-asset-location: <value in [no, yes]>
vpc-cidr: <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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0