fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc 模块 – Cloud orchest awstemplate autoscale new vpc
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc。
fortinet.fortimanager 2.2.0 中的新功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有在使用前需要根据数据源调整的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求的 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。 选择
|
|
设置的顶级参数。 |
|
可用区。 |
|
自定义资产容器。 |
|
自定义资产目录。 |
|
自定义标识符。 |
|
(列表) Faz 自动缩放管理员密码。 |
|
Faz 自动缩放管理员用户名。 |
|
Faz 自定义私有 IP 地址。 |
|
Faz 实例类型。 选择
|
|
Faz 集成选项。 选择
|
|
Faz 版本。 |
|
Fgt 管理 CIDR。 |
|
Fgt 管理端口。 |
|
Fgt 实例类型。 选择
|
|
Fgt PSK 密钥。 |
|
Fgtasg 冷静期。 |
|
Fgtasg BYOL 期望容量。 |
|
Fgtasg PAYG 期望容量。 |
|
Fgtasg 健康检查宽限期。 |
|
Fgtasg BYOL 最大大小。 |
|
Fgtasg PAYG 最大大小。 |
|
Fgtasg BYOL 最小大小。 |
|
Fgtasg PAYG 最小大小。 |
|
Fgtasg 缩容阈值。 |
|
Fgtasg 扩容阈值。 |
|
FOS 版本。 |
|
获取许可证宽限期。 |
|
心跳延迟容许值。 |
|
心跳间隔。 |
|
心跳丢失计数。 |
|
内部负载均衡器 DNS 名称。 |
|
内部负载均衡选项。 选择
|
|
内部目标组运行状况检查路径。 |
|
密钥对名称。 |
|
生命周期挂钩超时。 |
|
负载均衡运行状况检查阈值。 |
|
负载均衡流量端口。 |
|
负载均衡流量协议。 选择
|
|
名称。 |
|
通知电子邮件。 |
|
主节点选举超时。 |
|
私有子网 1 CIDR。 |
|
私有子网 2 CIDR。 |
|
公有子网 1 CIDR。 |
|
公有子网 2 CIDR。 |
|
资源标签前缀。 |
|
S3 存储桶名称。 |
|
S3 密钥前缀。 |
|
同步恢复计数。 |
|
终止不健康的虚拟机。 选择
|
|
使用自定义资产位置。 选择
|
|
VPC CIDR。 |
|
启用/禁用任务日志记录。 选择
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
底层 JSON RPC 请求的重写方法。 选择
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
用于创建、更新或删除对象的指令。 选择
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 root 的值。 |
|
等待其他用户释放工作区锁的最长时间（以秒为单位）。 默认值: |
注意
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件
示例
- 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>
返回值
通用返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回: 复杂 |