Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc module – Модуль Cloud orchest awstemplate autoscale tgw new vpc

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc.

Добавлено в fortinet.fortimanager 2.2.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настраивать устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

cloud_orchestawstemplate_autoscaletgwnewvpc

dictionary

Набор параметров верхнего уровня.

availability_zones

aliases: availability-zones

string

Зоны доступности.

bgp_asn

aliases: bgp-asn

integer

Номер автономной системы BGP.

custom_asset_container

aliases: custom-asset-container

string

Пользовательский контейнер ресурсов.

custom_asset_directory

aliases: custom-asset-directory

string

Пользовательский каталог ресурсов.

custom_identifier

aliases: custom-identifier

string

Пользовательский идентификатор.

faz_autoscale_admin_password

aliases: faz-autoscale-admin-password

any

(список) Пароль администратора автомасштабирования FAZ.

faz_autoscale_admin_username

aliases: faz-autoscale-admin-username

string

Имя пользователя администратора автомасштабирования FAZ.

faz_custom_private_ipaddress

aliases: faz-custom-private-ipaddress

string

Пользовательский частный IP-адрес FAZ.

faz_instance_type

aliases: faz-instance-type

string

Тип экземпляра FAZ.

Варианты:

  • "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

aliases: faz-integration-options

string

Параметры интеграции FAZ.

Варианты:

  • "no"
  • "yes"

faz_version

aliases: faz-version

string

Версия FAZ.

fgt_admin_cidr

aliases: fgt-admin-cidr

string

Диапазон CIDR для администрирования FGT.

fgt_admin_port

aliases: fgt-admin-port

integer

Порт администрирования FGT.

fgt_instance_type

aliases: fgt-instance-type

string

Тип экземпляра FGT.

Варианты:

  • "t2.small"
  • "c5.large"
  • "c5.xlarge"
  • "c5.2xlarge"
  • "c5.4xlarge"
  • "c5.9xlarge"

fgt_psk_secret

aliases: fgt-psk-secret

string

Предварительно заданный общий секрет FGT.

fgtasg_cool_down

aliases: fgtasg-cool-down

integer

Период ожидания FGT Auto Scaling Group.

fgtasg_desired_capacity_byol

aliases: fgtasg-desired-capacity-byol

integer

Требуемая емкость FGT Auto Scaling Group для BYOL.

fgtasg_desired_capacity_payg

aliases: fgtasg-desired-capacity-payg

integer

Требуемая емкость FGT Auto Scaling Group для PAYG.

fgtasg_health_check_grace_period

aliases: fgtasg-health-check-grace-period

integer

Период ожидания проверки работоспособности FGT Auto Scaling Group.

fgtasg_max_size_byol

aliases: fgtasg-max-size-byol

integer

Максимальный размер FGT Auto Scaling Group для BYOL.

fgtasg_max_size_payg

aliases: fgtasg-max-size-payg

integer

Максимальный размер FGT Auto Scaling Group для PAYG.

fgtasg_min_size_byol

aliases: fgtasg-min-size-byol

integer

Минимальный размер FGT Auto Scaling Group для BYOL.

fgtasg_min_size_payg

aliases: fgtasg-min-size-payg

integer

Минимальный размер FGT Auto Scaling Group для PAYG.

fgtasg_scale_in_threshold

aliases: fgtasg-scale-in-threshold

integer

Порог уменьшения масштаба FGT Auto Scaling Group.

fgtasg_scale_out_threshold

aliases: fgtasg-scale-out-threshold

integer

Порог увеличения масштаба FGT Auto Scaling Group.

fos_version

aliases: fos-version

string

Версия FOS.

get_license_grace_period

aliases: get-license-grace-period

integer

Получить льготный период лицензии.

heartbeat_delay_allowance

aliases: heartbeat-delay-allowance

integer

Допустимая задержка сигнала проверки связи.

heartbeat_interval

aliases: heartbeat-interval

integer

Интервал сигнала проверки связи.

heartbeat_loss_count

aliases: heartbeat-loss-count

integer

Количество пропущенных сигналов проверки связи.

key_pair_name

aliases: key-pair-name

string

Имя пары ключей.

lifecycle_hook_timeout

aliases: lifecycle-hook-timeout

integer

Время ожидания перехватчика жизненного цикла.

name

string / обязательный

Имя.

notification_email

aliases: notification-email

string

Адрес электронной почты для уведомлений.

primary_election_timeout

aliases: primary-election-timeout

integer

Время ожидания выбора основного узла.

public_subnet1_cidr

aliases: public-subnet1-cidr

string

Диапазон CIDR общедоступной подсети 1.

public_subnet2_cidr

aliases: public-subnet2-cidr

string

Диапазон CIDR общедоступной подсети 2.

resource_tag_prefix

aliases: resource-tag-prefix

string

Префикс тега ресурса.

s3_bucket_name

aliases: s3-bucket-name

string

Имя корзины S3.

s3_key_prefix

aliases: s3-key-prefix

string

Префикс ключа S3.

sync_recovery_count

aliases: sync-recovery-count

integer

Количество попыток синхронизации при восстановлении.

terminate_unhealthy_vm

aliases: terminate-unhealthy-vm

string

Завершать работу неисправной виртуальной машины.

Варианты:

  • "no"
  • "yes"

transit_gateway_id

aliases: transit-gateway-id

string

Идентификатор транзитного шлюза.

transit_gateway_support_options

aliases: transit-gateway-support-options

string

Параметры поддержки транзитного шлюза.

Варианты:

  • "create one"
  • "use an existing one"

use_custom_asset_location

aliases: use-custom-asset-location

string

Использовать пользовательское расположение ресурсов.

Варианты:

  • "no"
  • "yes"

vpc_cidr

aliases: vpc-cidr

string

Блок CIDR VPC.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Cloud orchest awstemplate autoscale tgw new vpc
      fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        cloud_orchestawstemplate_autoscaletgwnewvpc:
          name: "your value" # Required variable, string
          # availability_zones: <string>
          # bgp_asn: <integer>
          # 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>
          # key_pair_name: <string>
          # lifecycle_hook_timeout: <integer>
          # notification_email: <string>
          # primary_election_timeout: <integer>
          # 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]>
          # transit_gateway_id: <string>
          # transit_gateway_support_options: <value in [create one, use an existing one]>
          # use_custom_asset_location: <value in [no, yes]>
          # vpc_cidr: <string>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager.

Возвращается: при сложных условиях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API