fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaleexistingvpc module – Cloud orchest awstemplate autoscale existing vpc
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_cloud_orchestawstemplate_autoscaleexistingvpc.
New in fortinet.fortimanager 2.2.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to custom_asset_container. Custom asset container. |
|
Deprecated, please rename it to custom_asset_directory. Custom asset directory. |
|
Deprecated, please rename it to custom_identifier. Custom identifier. |
|
(list) Deprecated, please rename it to faz_autoscale_admin_password. Faz autoscale admin password. |
|
Deprecated, please rename it to faz_autoscale_admin_username. Faz autoscale admin username. |
|
Deprecated, please rename it to faz_custom_private_ipaddress. Faz custom private ipaddress. |
|
Deprecated, please rename it to faz_instance_type. Faz instance type. Choices:
|
|
Deprecated, please rename it to faz_integration_options. Faz integration options. Choices:
|
|
Deprecated, please rename it to faz_version. Faz version. |
|
Deprecated, please rename it to fgt_admin_cidr. Fgt admin cidr. |
|
Deprecated, please rename it to fgt_admin_port. Fgt admin port. |
|
Deprecated, please rename it to fgt_instance_type. Fgt instance type. Choices:
|
|
Deprecated, please rename it to fgt_psk_secret. Fgt psk secret. |
|
Deprecated, please rename it to fgtasg_cool_down. Fgtasg cool down. |
|
Deprecated, please rename it to fgtasg_desired_capacity_byol. Fgtasg desired capacity byol. |
|
Deprecated, please rename it to fgtasg_desired_capacity_payg. Fgtasg desired capacity payg. |
|
Deprecated, please rename it to fgtasg_health_check_grace_period. Fgtasg health check grace period. |
|
Deprecated, please rename it to fgtasg_max_size_byol. Fgtasg max size byol. |
|
Deprecated, please rename it to fgtasg_max_size_payg. Fgtasg max size payg. |
|
Deprecated, please rename it to fgtasg_min_size_byol. Fgtasg min size byol. |
|
Deprecated, please rename it to fgtasg_min_size_payg. Fgtasg min size payg. |
|
Deprecated, please rename it to fgtasg_scale_in_threshold. Fgtasg scale in threshold. |
|
Deprecated, please rename it to fgtasg_scale_out_threshold. Fgtasg scale out threshold. |
|
Deprecated, please rename it to fos_version. Fos version. |
|
Deprecated, please rename it to get_license_grace_period. Get license grace period. |
|
Deprecated, please rename it to heartbeat_delay_allowance. Heartbeat delay allowance. |
|
Deprecated, please rename it to heartbeat_interval. Heartbeat interval. |
|
Deprecated, please rename it to heartbeat_loss_count. Heartbeat loss count. |
|
Deprecated, please rename it to internal_balancer_dns_name. Internal balancer dns name. |
|
Deprecated, please rename it to internal_balancing_options. Internal balancing options. Choices:
|
|
Deprecated, please rename it to internal_target_group_health_check_path. Internal target group health check path. |
|
Deprecated, please rename it to key_pair_name. Key pair name. |
|
Deprecated, please rename it to lifecycle_hook_timeout. Lifecycle hook timeout. |
|
Deprecated, please rename it to loadbalancing_health_check_threshold. Loadbalancing health check threshold. |
|
Deprecated, please rename it to loadbalancing_traffic_port. Loadbalancing traffic port. |
|
Deprecated, please rename it to loadbalancing_traffic_protocol. Loadbalancing traffic protocol. Choices:
|
|
Name. |
|
Deprecated, please rename it to notification_email. Notification email. |
|
Deprecated, please rename it to primary_election_timeout. Primary election timeout. |
|
Deprecated, please rename it to private_subnet_route_table. Private subnet route table. |
|
Deprecated, please rename it to private_subnet1. Private subnet1. |
|
Deprecated, please rename it to private_subnet2. Private subnet2. |
|
Deprecated, please rename it to public_subnet1. Public subnet1. |
|
Deprecated, please rename it to public_subnet2. Public subnet2. |
|
Deprecated, please rename it to resource_tag_prefix. Resource tag prefix. |
|
Deprecated, please rename it to s3_bucket_name. S3 bucket name. |
|
Deprecated, please rename it to s3_key_prefix. S3 key prefix. |
|
Deprecated, please rename it to sync_recovery_count. Sync recovery count. |
|
Deprecated, please rename it to terminate_unhealthy_vm. Terminate unhealthy vm. Choices:
|
|
Deprecated, please rename it to use_custom_asset_location. Use custom asset location. Choices:
|
|
Deprecated, please rename it to vpc_cidr. Vpc cidr. |
|
Deprecated, please rename it to vpc_endpoint_id. Vpc endpoint id. |
|
Deprecated, please rename it to vpc_id. Vpc id. |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Cloud orchest awstemplate autoscale existing vpc
fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaleexistingvpc:
# 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: present # <value in [present, absent]>
cloud_orchestawstemplate_autoscaleexistingvpc:
custom_asset_container: <string>
custom_asset_directory: <string>
custom_identifier: <string>
faz_autoscale_admin_password: <list or string>
faz_autoscale_admin_username: <string>
faz_custom_private_ipaddress: <string>
faz_instance_type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
faz_integration_options: <value in [no, yes]>
faz_version: <string>
fgt_admin_cidr: <string>
fgt_admin_port: <integer>
fgt_instance_type: <value in [t2.small, c5.large, c5.xlarge, ...]>
fgt_psk_secret: <string>
fgtasg_cool_down: <integer>
fgtasg_desired_capacity_byol: <integer>
fgtasg_desired_capacity_payg: <integer>
fgtasg_health_check_grace_period: <integer>
fgtasg_max_size_byol: <integer>
fgtasg_max_size_payg: <integer>
fgtasg_min_size_byol: <integer>
fgtasg_min_size_payg: <integer>
fgtasg_scale_in_threshold: <integer>
fgtasg_scale_out_threshold: <integer>
fos_version: <string>
get_license_grace_period: <integer>
heartbeat_delay_allowance: <integer>
heartbeat_interval: <integer>
heartbeat_loss_count: <integer>
internal_balancer_dns_name: <string>
internal_balancing_options: <value in [add a new internal load balancer, use a load balancer specified below, do not need one]>
internal_target_group_health_check_path: <string>
key_pair_name: <string>
lifecycle_hook_timeout: <integer>
loadbalancing_health_check_threshold: <integer>
loadbalancing_traffic_port: <integer>
loadbalancing_traffic_protocol: <value in [HTTPS, HTTP, TCP]>
name: <string>
notification_email: <string>
primary_election_timeout: <integer>
private_subnet_route_table: <string>
private_subnet1: <string>
private_subnet2: <string>
public_subnet1: <string>
public_subnet2: <string>
resource_tag_prefix: <string>
s3_bucket_name: <string>
s3_key_prefix: <string>
sync_recovery_count: <integer>
terminate_unhealthy_vm: <value in [no, yes]>
use_custom_asset_location: <value in [no, yes]>
vpc_cidr: <string>
vpc_endpoint_id: <string>
vpc_id: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |