You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaleexistingvpc module – no description

Note

This module is part of the fortinet.fortimanager collection (version 2.2.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
access_token string	The token to access FortiManager without using username and password.
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
cloud_orchestawstemplate_autoscaleexistingvpc dictionary	the top level parameters set
custom-asset-container string	no description
custom-asset-directory string	no description
custom-identifier string	no description
faz-autoscale-admin-password string	description
faz-autoscale-admin-username string	no description
faz-custom-private-ipaddress string	no description
faz-instance-type string	no description Choices: "h1.2xlarge" "h1.4xlarge" "h1.8xlarge" "m5.large" "m5.xlarge" "m5.2xlarge" "m5.4xlarge" "m5.12xlarge" "t2.medium" "t2.large" "t2.xlarge"
faz-integration-options string	no description Choices: "no" "yes"
faz-version string	no description
fgt-admin-cidr string	no description
fgt-admin-port integer	no description
fgt-instance-type string	no description Choices: "t2.small" "c5.large" "c5.xlarge" "c5.2xlarge" "c5.4xlarge" "c5.9xlarge"
fgt-psk-secret string	no description
fgtasg-cool-down integer	no description
fgtasg-desired-capacity-byol integer	no description
fgtasg-desired-capacity-payg integer	no description
fgtasg-health-check-grace-period integer	no description
fgtasg-max-size-byol integer	no description
fgtasg-max-size-payg integer	no description
fgtasg-min-size-byol integer	no description
fgtasg-min-size-payg integer	no description
fgtasg-scale-in-threshold integer	no description
fgtasg-scale-out-threshold integer	no description
fos-version string	no description
get-license-grace-period integer	no description
heartbeat-delay-allowance integer	no description
heartbeat-interval integer	no description
heartbeat-loss-count integer	no description
internal-balancer-dns-name string	no description
internal-balancing-options string	no description Choices: "add a new internal load balancer" "use a load balancer specified below" "do not need one"
internal-target-group-health-check-path string	no description
key-pair-name string	no description
lifecycle-hook-timeout integer	no description
loadbalancing-health-check-threshold integer	no description
loadbalancing-traffic-port integer	no description
loadbalancing-traffic-protocol string	no description Choices: "HTTPS" "HTTP" "TCP"
name string	no description
notification-email string	no description
primary-election-timeout integer	no description
private-subnet-route-table string	no description
private-subnet1 string	no description
private-subnet2 string	no description
public-subnet1 string	no description
public-subnet2 string	no description
resource-tag-prefix string	no description
s3-bucket-name string	no description
s3-key-prefix string	no description
sync-recovery-count integer	no description
terminate-unhealthy-vm string	no description Choices: "no" "yes"
use-custom-asset-location string	no description Choices: "no" "yes"
vpc-cidr string	no description
vpc-endpoint-id string	no description
vpc-id string	no description
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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_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: <value in [present, absent]>
        cloud_orchestawstemplate_autoscaleexistingvpc:
           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>
           internal-balancer-dns-name: <value of 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: <value of string>
           key-pair-name: <value of string>
           lifecycle-hook-timeout: <value of integer>
           loadbalancing-health-check-threshold: <value of integer>
           loadbalancing-traffic-port: <value of integer>
           loadbalancing-traffic-protocol: <value in [HTTPS, HTTP, TCP]>
           name: <value of string>
           notification-email: <value of string>
           primary-election-timeout: <value of integer>
           private-subnet-route-table: <value of string>
           private-subnet1: <value of string>
           private-subnet2: <value of string>
           public-subnet1: <value of string>
           public-subnet2: <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]>
           use-custom-asset-location: <value in [no, yes]>
           vpc-cidr: <value of string>
           vpc-endpoint-id: <value of string>
           vpc-id: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)