:source: fmgr_cloud_orchestawstemplate_autoscaleexistingvpc.py
:orphan:
.. _fmgr_cloud_orchestawstemplate_autoscaleexistingvpc:
fmgr_cloud_orchestawstemplate_autoscaleexistingvpc -- Cloud orchest awstemplate autoscale existing vpc.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.2.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.0 -> latest
Parameters
----------
.. raw:: html
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- cloud_orchestawstemplate_autoscaleexistingvpc - Cloud orchest awstemplate autoscale existing vpc type: dict
- custom_asset_container (Alias name: custom-asset-container) Custom asset container. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- custom_asset_directory (Alias name: custom-asset-directory) Custom asset directory. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- custom_identifier (Alias name: custom-identifier) Custom identifier. type: str default: fgtASG
more...
Supported Version Ranges: v7.4.0 -> latest
- faz_autoscale_admin_password (Alias name: faz-autoscale-admin-password) Faz autoscale admin password. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- faz_autoscale_admin_username (Alias name: faz-autoscale-admin-username) Faz autoscale admin username. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- faz_custom_private_ipaddress (Alias name: faz-custom-private-ipaddress) Faz custom private ipaddress. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- faz_instance_type (Alias name: faz-instance-type) Faz instance type. 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...
Supported Version Ranges: v7.4.0 -> latest
- faz_integration_options (Alias name: faz-integration-options) Faz integration options. type: str choices: [no, yes] default: no
more...
Supported Version Ranges: v7.4.0 -> latest
- faz_version (Alias name: faz-version) Faz version. type: str default: 7.2.0
more...
Supported Version Ranges: v7.4.0 -> latest
- fgt_admin_cidr (Alias name: fgt-admin-cidr) Fgt admin cidr. type: str default: 0.0.0.0/0
more...
Supported Version Ranges: v7.4.0 -> latest
- fgt_admin_port (Alias name: fgt-admin-port) Fgt admin port. type: int default: 8443
more...
Supported Version Ranges: v7.4.0 -> latest
- fgt_instance_type (Alias name: fgt-instance-type) Fgt instance type. type: str choices: [t2.small, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge] default: c5.xlarge
more...
Supported Version Ranges: v7.4.0 -> latest
- fgt_psk_secret (Alias name: fgt-psk-secret) Fgt psk secret. type: str default: S1c21t@FGT
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_cool_down (Alias name: fgtasg-cool-down) Fgtasg cool down. type: int default: 300
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_desired_capacity_byol (Alias name: fgtasg-desired-capacity-byol) Fgtasg desired capacity byol. type: int default: 2
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_desired_capacity_payg (Alias name: fgtasg-desired-capacity-payg) Fgtasg desired capacity payg. type: int default: 0
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_health_check_grace_period (Alias name: fgtasg-health-check-grace-period) Fgtasg health check grace period. type: int default: 300
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_max_size_byol (Alias name: fgtasg-max-size-byol) Fgtasg max size byol. type: int default: 2
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_max_size_payg (Alias name: fgtasg-max-size-payg) Fgtasg max size payg. type: int default: 6
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_min_size_byol (Alias name: fgtasg-min-size-byol) Fgtasg min size byol. type: int default: 2
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_min_size_payg (Alias name: fgtasg-min-size-payg) Fgtasg min size payg. type: int default: 0
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_scale_in_threshold (Alias name: fgtasg-scale-in-threshold) Fgtasg scale in threshold. type: int default: 25
more...
Supported Version Ranges: v7.4.0 -> latest
- fgtasg_scale_out_threshold (Alias name: fgtasg-scale-out-threshold) Fgtasg scale out threshold. type: int default: 80
more...
Supported Version Ranges: v7.4.0 -> latest
- fos_version (Alias name: fos-version) Fos version. type: str default: 7.2.4
more...
Supported Version Ranges: v7.4.0 -> latest
- get_license_grace_period (Alias name: get-license-grace-period) Get license grace period. type: int default: 600
more...
Supported Version Ranges: v7.4.0 -> latest
- heartbeat_delay_allowance (Alias name: heartbeat-delay-allowance) Heartbeat delay allowance. type: int default: 2
more...
Supported Version Ranges: v7.4.0 -> latest
- heartbeat_interval (Alias name: heartbeat-interval) Heartbeat interval. type: int default: 30
more...
Supported Version Ranges: v7.4.0 -> latest
- heartbeat_loss_count (Alias name: heartbeat-loss-count) Heartbeat loss count. type: int default: 10
more...
Supported Version Ranges: v7.4.0 -> latest
- internal_balancer_dns_name (Alias name: internal-balancer-dns-name) Internal balancer dns name. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- internal_balancing_options (Alias name: internal-balancing-options) Internal balancing options. type: str choices: [add a new internal load balancer, use a load balancer specified below, do not need one] default: add a new internal load balancer
more...
Supported Version Ranges: v7.4.0 -> latest
- internal_target_group_health_check_path (Alias name: internal-target-group-health-check-path) Internal target group health check path. type: str default: /
more...
Supported Version Ranges: v7.4.0 -> latest
- key_pair_name (Alias name: key-pair-name) Key pair name. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- lifecycle_hook_timeout (Alias name: lifecycle-hook-timeout) Lifecycle hook timeout. type: int default: 480
more...
Supported Version Ranges: v7.4.0 -> latest
- loadbalancing_health_check_threshold (Alias name: loadbalancing-health-check-threshold) Loadbalancing health check threshold. type: int default: 3
more...
Supported Version Ranges: v7.4.0 -> latest
- loadbalancing_traffic_port (Alias name: loadbalancing-traffic-port) Loadbalancing traffic port. type: int default: 443
more...
Supported Version Ranges: v7.4.0 -> latest
- loadbalancing_traffic_protocol (Alias name: loadbalancing-traffic-protocol) Loadbalancing traffic protocol. type: str choices: [HTTPS, HTTP, TCP] default: HTTPS
more...
Supported Version Ranges: v7.4.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- notification_email (Alias name: notification-email) Notification email. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- primary_election_timeout (Alias name: primary-election-timeout) Primary election timeout. type: int default: 300
more...
Supported Version Ranges: v7.4.0 -> latest
- private_subnet_route_table (Alias name: private-subnet-route-table) Private subnet route table. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- private_subnet1 (Alias name: private-subnet1) Private subnet1. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- private_subnet2 (Alias name: private-subnet2) Private subnet2. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- public_subnet1 (Alias name: public-subnet1) Public subnet1. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- public_subnet2 (Alias name: public-subnet2) Public subnet2. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- resource_tag_prefix (Alias name: resource-tag-prefix) Resource tag prefix. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- s3_bucket_name (Alias name: s3-bucket-name) S3 bucket name. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- s3_key_prefix (Alias name: s3-key-prefix) S3 key prefix. type: str default:
more...
Supported Version Ranges: v7.4.0 -> latest
- sync_recovery_count (Alias name: sync-recovery-count) Sync recovery count. type: int default: 3
more...
Supported Version Ranges: v7.4.0 -> latest
- terminate_unhealthy_vm (Alias name: terminate-unhealthy-vm) Terminate unhealthy vm. type: str choices: [no, yes] default: no
more...
Supported Version Ranges: v7.4.0 -> latest
- use_custom_asset_location (Alias name: use-custom-asset-location) Use custom asset location. type: str choices: [no, yes] default: no
more...
Supported Version Ranges: v7.4.0 -> latest
- vpc_cidr (Alias name: vpc-cidr) Vpc cidr. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- vpc_endpoint_id (Alias name: vpc-endpoint-id) Vpc endpoint id. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- vpc_id (Alias name: vpc-id) Vpc id. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Cloud orchest awstemplate autoscale existing vpc
fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaleexistingvpc:
# workspace_locking_adom:
adom:
state: present #
cloud_orchestawstemplate_autoscaleexistingvpc:
name: "your value" # Required variable, string
# custom_asset_container:
# custom_asset_directory:
# custom_identifier:
# faz_autoscale_admin_password:
# faz_autoscale_admin_username:
# faz_custom_private_ipaddress:
# faz_instance_type:
# faz_integration_options:
# faz_version:
# fgt_admin_cidr:
# fgt_admin_port:
# fgt_instance_type:
# fgt_psk_secret:
# fgtasg_cool_down:
# fgtasg_desired_capacity_byol:
# fgtasg_desired_capacity_payg:
# fgtasg_health_check_grace_period:
# fgtasg_max_size_byol:
# fgtasg_max_size_payg:
# fgtasg_min_size_byol:
# fgtasg_min_size_payg:
# fgtasg_scale_in_threshold:
# fgtasg_scale_out_threshold:
# fos_version:
# get_license_grace_period:
# heartbeat_delay_allowance:
# heartbeat_interval:
# heartbeat_loss_count:
# internal_balancer_dns_name:
# internal_balancing_options:
# internal_target_group_health_check_path:
# key_pair_name:
# lifecycle_hook_timeout:
# loadbalancing_health_check_threshold:
# loadbalancing_traffic_port:
# loadbalancing_traffic_protocol:
# notification_email:
# primary_election_timeout:
# private_subnet_route_table:
# private_subnet1:
# private_subnet2:
# public_subnet1:
# public_subnet2:
# resource_tag_prefix:
# s3_bucket_name:
# s3_key_prefix:
# sync_recovery_count:
# terminate_unhealthy_vm:
# use_custom_asset_location:
# vpc_cidr:
# vpc_endpoint_id:
# vpc_id:
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:
.. raw:: html
- 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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)