fmgr_cloud_orchestawstemplate_autoscalenewvpc – Cloud orchest awstemplate autoscale new vpc.
Added in version 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.
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>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.0 -> latest
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_autoscalenewvpc - Cloud orchest awstemplate autoscale new vpc type: dict
- availability_zones (Alias name: availability-zones) Availability zones. type: str more...
- custom_asset_container (Alias name: custom-asset-container) Custom asset container. type: str default: more...
- custom_asset_directory (Alias name: custom-asset-directory) Custom asset directory. type: str default: more...
- custom_identifier (Alias name: custom-identifier) Custom identifier. type: str default: fgtASG more...
- faz_autoscale_admin_password (Alias name: faz-autoscale-admin-password) Faz autoscale admin password. type: list more...
- faz_autoscale_admin_username (Alias name: faz-autoscale-admin-username) Faz autoscale admin username. type: str default: more...
- faz_custom_private_ipaddress (Alias name: faz-custom-private-ipaddress) Faz custom private ipaddress. type: str default: more...
- 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...
- faz_integration_options (Alias name: faz-integration-options) Faz integration options. type: str choices: [no, yes] default: no more...
- faz_version (Alias name: faz-version) Faz version. type: str default: 7.2.0 more...
- fgt_admin_cidr (Alias name: fgt-admin-cidr) Fgt admin cidr. type: str default: 0.0.0.0/0 more...
- fgt_admin_port (Alias name: fgt-admin-port) Fgt admin port. type: int default: 8443 more...
- 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...
- fgt_psk_secret (Alias name: fgt-psk-secret) Fgt psk secret. type: str default: S1c21t@FGT more...
- fgtasg_cool_down (Alias name: fgtasg-cool-down) Fgtasg cool down. type: int default: 300 more...
- fgtasg_desired_capacity_byol (Alias name: fgtasg-desired-capacity-byol) Fgtasg desired capacity byol. type: int default: 2 more...
- fgtasg_desired_capacity_payg (Alias name: fgtasg-desired-capacity-payg) Fgtasg desired capacity payg. type: int default: 0 more...
- fgtasg_health_check_grace_period (Alias name: fgtasg-health-check-grace-period) Fgtasg health check grace period. type: int default: 300 more...
- fgtasg_max_size_byol (Alias name: fgtasg-max-size-byol) Fgtasg max size byol. type: int default: 2 more...
- fgtasg_max_size_payg (Alias name: fgtasg-max-size-payg) Fgtasg max size payg. type: int default: 6 more...
- fgtasg_min_size_byol (Alias name: fgtasg-min-size-byol) Fgtasg min size byol. type: int default: 2 more...
- fgtasg_min_size_payg (Alias name: fgtasg-min-size-payg) Fgtasg min size payg. type: int default: 0 more...
- fgtasg_scale_in_threshold (Alias name: fgtasg-scale-in-threshold) Fgtasg scale in threshold. type: int default: 25 more...
- fgtasg_scale_out_threshold (Alias name: fgtasg-scale-out-threshold) Fgtasg scale out threshold. type: int default: 80 more...
- fos_version (Alias name: fos-version) Fos version. type: str default: 7.2.4 more...
- get_license_grace_period (Alias name: get-license-grace-period) Get license grace period. type: int default: 600 more...
- heartbeat_delay_allowance (Alias name: heartbeat-delay-allowance) Heartbeat delay allowance. type: int default: 2 more...
- heartbeat_interval (Alias name: heartbeat-interval) Heartbeat interval. type: int default: 30 more...
- heartbeat_loss_count (Alias name: heartbeat-loss-count) Heartbeat loss count. type: int default: 10 more...
- internal_balancer_dns_name (Alias name: internal-balancer-dns-name) Internal balancer dns name. type: str default: more...
- 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...
- internal_target_group_health_check_path (Alias name: internal-target-group-health-check-path) Internal target group health check path. type: str default: / more...
- key_pair_name (Alias name: key-pair-name) Key pair name. type: str more...
- lifecycle_hook_timeout (Alias name: lifecycle-hook-timeout) Lifecycle hook timeout. type: int default: 480 more...
- loadbalancing_health_check_threshold (Alias name: loadbalancing-health-check-threshold) Loadbalancing health check threshold. type: int default: 3 more...
- loadbalancing_traffic_port (Alias name: loadbalancing-traffic-port) Loadbalancing traffic port. type: int default: 443 more...
- loadbalancing_traffic_protocol (Alias name: loadbalancing-traffic-protocol) Loadbalancing traffic protocol. type: str choices: [HTTPS, HTTP, TCP] default: HTTPS more...
- name Name. type: str more...
- notification_email (Alias name: notification-email) Notification email. type: str default: more...
- primary_election_timeout (Alias name: primary-election-timeout) Primary election timeout. type: int default: 300 more...
- private_subnet1_cidr (Alias name: private-subnet1-cidr) Private subnet1 cidr. type: str default: 192.168.2.0/24 more...
- private_subnet2_cidr (Alias name: private-subnet2-cidr) Private subnet2 cidr. type: str default: 192.168.3.0/24 more...
- public_subnet1_cidr (Alias name: public-subnet1-cidr) Public subnet1 cidr. type: str default: 192.168.0.0/24 more...
- public_subnet2_cidr (Alias name: public-subnet2-cidr) Public subnet2 cidr. type: str default: 192.168.1.0/24 more...
- resource_tag_prefix (Alias name: resource-tag-prefix) Resource tag prefix. type: str more...
- s3_bucket_name (Alias name: s3-bucket-name) S3 bucket name. type: str default: more...
- s3_key_prefix (Alias name: s3-key-prefix) S3 key prefix. type: str default: more...
- sync_recovery_count (Alias name: sync-recovery-count) Sync recovery count. type: int default: 3 more...
- terminate_unhealthy_vm (Alias name: terminate-unhealthy-vm) Terminate unhealthy vm. type: str choices: [no, yes] default: no more...
- use_custom_asset_location (Alias name: use-custom-asset-location) Use custom asset location. type: str choices: [no, yes] default: no more...
- vpc_cidr (Alias name: vpc-cidr) Vpc cidr. 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
- 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 new vpc
fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc:
# 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_autoscalenewvpc:
availability_zones: <string>
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_subnet1_cidr: <string>
private_subnet2_cidr: <string>
public_subnet1_cidr: <string>
public_subnet2_cidr: <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>
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 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.